@proto-kit/protocol 0.1.1-develop.0

package/dist/settlement/messages/OutgoingMessageArgument.d.ts

@@ -0,0 +1,197 @@
+import { RollupMerkleTreeWitness } from "@proto-kit/common";
+import { Withdrawal } from "./Withdrawal";
+export declare const OUTGOING_MESSAGE_BATCH_SIZE = 1;
+declare const OutgoingMessageArgument_base: (new (value: {
+    witness: RollupMerkleTreeWitness;
+    value: Withdrawal;
+}) => {
+    witness: RollupMerkleTreeWitness;
+    value: Withdrawal;
+}) & {
+    _isStruct: true;
+} & Omit<import("o1js/dist/node/lib/provable/types/provable-intf").Provable<{
+    witness: RollupMerkleTreeWitness;
+    value: Withdrawal;
+}, {
+    witness: {
+        path: bigint[];
+        isLeft: boolean[];
+    };
+    value: {
+        tokenId: bigint;
+        address: {
+            x: bigint;
+            isOdd: boolean;
+        };
+        amount: bigint;
+    };
+}>, "fromFields"> & {
+    fromFields: (fields: import("o1js/dist/node/lib/provable/field").Field[]) => {
+        witness: RollupMerkleTreeWitness;
+        value: Withdrawal;
+    };
+} & {
+    fromValue: (value: {
+        witness: RollupMerkleTreeWitness | {
+            path: import("o1js/dist/node/lib/provable/field").Field[] | bigint[];
+            isLeft: import("o1js/dist/node/lib/provable/bool").Bool[] | boolean[];
+        };
+        value: Withdrawal | {
+            tokenId: string | number | bigint | import("o1js/dist/node/lib/provable/field").Field;
+            address: import("o1js/dist/node/lib/provable/crypto/signature").PublicKey | {
+                x: bigint | import("o1js/dist/node/lib/provable/field").Field;
+                isOdd: boolean | import("o1js/dist/node/lib/provable/bool").Bool;
+            };
+            amount: bigint | import("o1js/dist/node/lib/provable/int").UInt64;
+        };
+    }) => {
+        witness: RollupMerkleTreeWitness;
+        value: Withdrawal;
+    };
+    toInput: (x: {
+        witness: RollupMerkleTreeWitness;
+        value: Withdrawal;
+    }) => {
+        fields?: import("o1js/dist/node/lib/provable/field").Field[] | undefined;
+        packed?: [import("o1js/dist/node/lib/provable/field").Field, number][] | undefined;
+    };
+    toJSON: (x: {
+        witness: RollupMerkleTreeWitness;
+        value: Withdrawal;
+    }) => {
+        witness: {
+            path: string[];
+            isLeft: boolean[];
+        };
+        value: {
+            tokenId: string;
+            address: string;
+            amount: string;
+        };
+    };
+    fromJSON: (x: {
+        witness: {
+            path: string[];
+            isLeft: boolean[];
+        };
+        value: {
+            tokenId: string;
+            address: string;
+            amount: string;
+        };
+    }) => {
+        witness: RollupMerkleTreeWitness;
+        value: Withdrawal;
+    };
+    empty: () => {
+        witness: RollupMerkleTreeWitness;
+        value: Withdrawal;
+    };
+};
+export declare class OutgoingMessageArgument extends OutgoingMessageArgument_base {
+    static dummy(): OutgoingMessageArgument;
+}
+declare const OutgoingMessageArgumentBatch_base: (new (value: {
+    arguments: OutgoingMessageArgument[];
+    isDummys: import("o1js/dist/node/lib/provable/bool").Bool[];
+}) => {
+    arguments: OutgoingMessageArgument[];
+    isDummys: import("o1js/dist/node/lib/provable/bool").Bool[];
+}) & {
+    _isStruct: true;
+} & Omit<import("o1js/dist/node/lib/provable/types/provable-intf").Provable<{
+    arguments: OutgoingMessageArgument[];
+    isDummys: import("o1js/dist/node/lib/provable/bool").Bool[];
+}, {
+    arguments: {
+        witness: {
+            path: bigint[];
+            isLeft: boolean[];
+        };
+        value: {
+            tokenId: bigint;
+            address: {
+                x: bigint;
+                isOdd: boolean;
+            };
+            amount: bigint;
+        };
+    }[];
+    isDummys: boolean[];
+}>, "fromFields"> & {
+    fromFields: (fields: import("o1js/dist/node/lib/provable/field").Field[]) => {
+        arguments: OutgoingMessageArgument[];
+        isDummys: import("o1js/dist/node/lib/provable/bool").Bool[];
+    };
+} & {
+    fromValue: (value: {
+        arguments: OutgoingMessageArgument[] | {
+            witness: {
+                path: bigint[];
+                isLeft: boolean[];
+            };
+            value: {
+                tokenId: bigint;
+                address: {
+                    x: bigint;
+                    isOdd: boolean;
+                };
+                amount: bigint;
+            };
+        }[];
+        isDummys: import("o1js/dist/node/lib/provable/bool").Bool[] | boolean[];
+    }) => {
+        arguments: OutgoingMessageArgument[];
+        isDummys: import("o1js/dist/node/lib/provable/bool").Bool[];
+    };
+    toInput: (x: {
+        arguments: OutgoingMessageArgument[];
+        isDummys: import("o1js/dist/node/lib/provable/bool").Bool[];
+    }) => {
+        fields?: import("o1js/dist/node/lib/provable/field").Field[] | undefined;
+        packed?: [import("o1js/dist/node/lib/provable/field").Field, number][] | undefined;
+    };
+    toJSON: (x: {
+        arguments: OutgoingMessageArgument[];
+        isDummys: import("o1js/dist/node/lib/provable/bool").Bool[];
+    }) => {
+        arguments: {
+            witness: {
+                path: string[];
+                isLeft: boolean[];
+            };
+            value: {
+                tokenId: string;
+                address: string;
+                amount: string;
+            };
+        }[];
+        isDummys: boolean[];
+    };
+    fromJSON: (x: {
+        arguments: {
+            witness: {
+                path: string[];
+                isLeft: boolean[];
+            };
+            value: {
+                tokenId: string;
+                address: string;
+                amount: string;
+            };
+        }[];
+        isDummys: boolean[];
+    }) => {
+        arguments: OutgoingMessageArgument[];
+        isDummys: import("o1js/dist/node/lib/provable/bool").Bool[];
+    };
+    empty: () => {
+        arguments: OutgoingMessageArgument[];
+        isDummys: import("o1js/dist/node/lib/provable/bool").Bool[];
+    };
+};
+export declare class OutgoingMessageArgumentBatch extends OutgoingMessageArgumentBatch_base {
+    static fromMessages(providedArguments: OutgoingMessageArgument[]): OutgoingMessageArgumentBatch;
+}
+export {};
+//# sourceMappingURL=OutgoingMessageArgument.d.ts.map

package/dist/settlement/messages/OutgoingMessageArgument.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OutgoingMessageArgument.d.ts","sourceRoot":"","sources":["../../../src/settlement/messages/OutgoingMessageArgument.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAE5D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,eAAO,MAAM,2BAA2B,IAAI,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE7C,qBAAa,uBAAwB,SAAQ,4BAG3C;WACc,KAAK,IAAI,uBAAuB;CAM/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAED,qBAAa,4BAA6B,SAAQ,iCAOhD;WACc,YAAY,CAAC,iBAAiB,EAAE,uBAAuB,EAAE;CAcxE"}

package/dist/settlement/messages/OutgoingMessageArgument.js

@@ -0,0 +1,33 @@
+import { Bool, Provable, Struct } from "o1js";
+import { RollupMerkleTreeWitness } from "@proto-kit/common";
+import { Withdrawal } from "./Withdrawal";
+export const OUTGOING_MESSAGE_BATCH_SIZE = 1;
+export class OutgoingMessageArgument extends Struct({
+    witness: RollupMerkleTreeWitness,
+    value: Withdrawal,
+}) {
+    static dummy() {
+        return new OutgoingMessageArgument({
+            witness: RollupMerkleTreeWitness.dummy(),
+            value: Withdrawal.dummy(),
+        });
+    }
+}
+export class OutgoingMessageArgumentBatch extends Struct({
+    arguments: Provable.Array(OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE),
+    isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE),
+}) {
+    static fromMessages(providedArguments) {
+        const batch = providedArguments.slice();
+        const isDummys = batch.map(() => Bool(false));
+        while (batch.length < OUTGOING_MESSAGE_BATCH_SIZE) {
+            batch.push(OutgoingMessageArgument.dummy());
+            isDummys.push(Bool(true));
+        }
+        return new OutgoingMessageArgumentBatch({
+            arguments: batch,
+            isDummys,
+        });
+    }
+}
+//# sourceMappingURL=OutgoingMessageArgument.js.map

package/dist/settlement/messages/OutgoingMessageArgument.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OutgoingMessageArgument.js","sourceRoot":"","sources":["../../../src/settlement/messages/OutgoingMessageArgument.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9C,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAE5D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC;AAE7C,MAAM,OAAO,uBAAwB,SAAQ,MAAM,CAAC;IAClD,OAAO,EAAE,uBAAuB;IAChC,KAAK,EAAE,UAAU;CAClB,CAAC;IACO,MAAM,CAAC,KAAK;QACjB,OAAO,IAAI,uBAAuB,CAAC;YACjC,OAAO,EAAE,uBAAuB,CAAC,KAAK,EAAE;YACxC,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE;SAC1B,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,OAAO,4BAA6B,SAAQ,MAAM,CAAC;IACvD,SAAS,EAAE,QAAQ,CAAC,KAAK,CACvB,uBAAuB,EACvB,2BAA2B,CAC5B;IAED,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,2BAA2B,CAAC;CAC5D,CAAC;IACO,MAAM,CAAC,YAAY,CAAC,iBAA4C;QACrE,MAAM,KAAK,GAAG,iBAAiB,CAAC,KAAK,EAAE,CAAC;QACxC,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QAE9C,OAAO,KAAK,CAAC,MAAM,GAAG,2BAA2B,EAAE;YACjD,KAAK,CAAC,IAAI,CAAC,uBAAuB,CAAC,KAAK,EAAE,CAAC,CAAC;YAC5C,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;SAC3B;QAED,OAAO,IAAI,4BAA4B,CAAC;YACtC,SAAS,EAAE,KAAK;YAChB,QAAQ;SACT,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/settlement/messages/Withdrawal.d.ts

@@ -0,0 +1,78 @@
+import { PublicKey, UInt64 } from "o1js";
+declare const Withdrawal_base: (new (value: {
+    tokenId: import("o1js/dist/node/lib/provable/field").Field;
+    address: PublicKey;
+    amount: UInt64;
+}) => {
+    tokenId: import("o1js/dist/node/lib/provable/field").Field;
+    address: PublicKey;
+    amount: UInt64;
+}) & {
+    _isStruct: true;
+} & Omit<import("o1js/dist/node/lib/provable/types/provable-intf").Provable<{
+    tokenId: import("o1js/dist/node/lib/provable/field").Field;
+    address: PublicKey;
+    amount: UInt64;
+}, {
+    tokenId: bigint;
+    address: {
+        x: bigint;
+        isOdd: boolean;
+    };
+    amount: bigint;
+}>, "fromFields"> & {
+    fromFields: (fields: import("o1js/dist/node/lib/provable/field").Field[]) => {
+        tokenId: import("o1js/dist/node/lib/provable/field").Field;
+        address: PublicKey;
+        amount: UInt64;
+    };
+} & {
+    fromValue: (value: {
+        tokenId: string | number | bigint | import("o1js/dist/node/lib/provable/field").Field;
+        address: PublicKey | {
+            x: bigint | import("o1js/dist/node/lib/provable/field").Field;
+            isOdd: boolean | import("o1js/dist/node/lib/provable/bool").Bool;
+        };
+        amount: bigint | UInt64;
+    }) => {
+        tokenId: import("o1js/dist/node/lib/provable/field").Field;
+        address: PublicKey;
+        amount: UInt64;
+    };
+    toInput: (x: {
+        tokenId: import("o1js/dist/node/lib/provable/field").Field;
+        address: PublicKey;
+        amount: UInt64;
+    }) => {
+        fields?: import("o1js/dist/node/lib/provable/field").Field[] | undefined;
+        packed?: [import("o1js/dist/node/lib/provable/field").Field, number][] | undefined;
+    };
+    toJSON: (x: {
+        tokenId: import("o1js/dist/node/lib/provable/field").Field;
+        address: PublicKey;
+        amount: UInt64;
+    }) => {
+        tokenId: string;
+        address: string;
+        amount: string;
+    };
+    fromJSON: (x: {
+        tokenId: string;
+        address: string;
+        amount: string;
+    }) => {
+        tokenId: import("o1js/dist/node/lib/provable/field").Field;
+        address: PublicKey;
+        amount: UInt64;
+    };
+    empty: () => {
+        tokenId: import("o1js/dist/node/lib/provable/field").Field;
+        address: PublicKey;
+        amount: UInt64;
+    };
+};
+export declare class Withdrawal extends Withdrawal_base {
+    static dummy(): Withdrawal;
+}
+export {};
+//# sourceMappingURL=Withdrawal.d.ts.map

package/dist/settlement/messages/Withdrawal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Withdrawal.d.ts","sourceRoot":"","sources":["../../../src/settlement/messages/Withdrawal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,SAAS,EAAU,MAAM,EAAE,MAAM,MAAM,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGxD,qBAAa,UAAW,SAAQ,eAI9B;WACc,KAAK;CAOpB"}

package/dist/settlement/messages/Withdrawal.js

@@ -0,0 +1,16 @@
+import { Field, PublicKey, Struct, UInt64 } from "o1js";
+import { EMPTY_PUBLICKEY } from "@proto-kit/common";
+export class Withdrawal extends Struct({
+    tokenId: Field,
+    address: PublicKey,
+    amount: UInt64,
+}) {
+    static dummy() {
+        return new Withdrawal({
+            tokenId: Field(0),
+            address: EMPTY_PUBLICKEY,
+            amount: UInt64.from(0),
+        });
+    }
+}
+//# sourceMappingURL=Withdrawal.js.map

package/dist/settlement/messages/Withdrawal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Withdrawal.js","sourceRoot":"","sources":["../../../src/settlement/messages/Withdrawal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,MAAM,OAAO,UAAW,SAAQ,MAAM,CAAC;IACrC,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,MAAM;CACf,CAAC;IACO,MAAM,CAAC,KAAK;QACjB,OAAO,IAAI,UAAU,CAAC;YACpB,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;YACjB,OAAO,EAAE,eAAe;YACxB,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;SACvB,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/settlement/modularity/ProvableSettlementHook.d.ts

@@ -0,0 +1,26 @@
+import { Field, PublicKey, UInt32 } from "o1js";
+import { InferProofBase } from "@proto-kit/common";
+import { ProtocolModule } from "../../protocol/ProtocolModule";
+import { NetworkState } from "../../model/network/NetworkState";
+import type { BlockProof } from "../../prover/block/BlockProver";
+import type { SettlementSmartContractBase } from "../contracts/SettlementSmartContract";
+export type InputBlockProof = InferProofBase<BlockProof>;
+export type SettlementStateRecord = {
+    sequencerKey: PublicKey;
+    lastSettlementL1BlockHeight: UInt32;
+    stateRoot: Field;
+    networkStateHash: Field;
+    blockHashRoot: Field;
+};
+export type SettlementHookInputs = {
+    blockProof: InputBlockProof;
+    fromNetworkState: NetworkState;
+    toNetworkState: NetworkState;
+    newPromisedMessagesHash: Field;
+    contractState: SettlementStateRecord;
+    currentL1BlockHeight: UInt32;
+};
+export declare abstract class ProvableSettlementHook<Config> extends ProtocolModule<Config> {
+    abstract beforeSettlement(smartContract: SettlementSmartContractBase, inputs: SettlementHookInputs): Promise<void>;
+}
+//# sourceMappingURL=ProvableSettlementHook.d.ts.map

package/dist/settlement/modularity/ProvableSettlementHook.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProvableSettlementHook.d.ts","sourceRoot":"","sources":["../../../src/settlement/modularity/ProvableSettlementHook.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEnD,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAChE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,sCAAsC,CAAC;AAExF,MAAM,MAAM,eAAe,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC;AAEzD,MAAM,MAAM,qBAAqB,GAAG;IAClC,YAAY,EAAE,SAAS,CAAC;IACxB,2BAA2B,EAAE,MAAM,CAAC;IAEpC,SAAS,EAAE,KAAK,CAAC;IACjB,gBAAgB,EAAE,KAAK,CAAC;IACxB,aAAa,EAAE,KAAK,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,UAAU,EAAE,eAAe,CAAC;IAC5B,gBAAgB,EAAE,YAAY,CAAC;IAC/B,cAAc,EAAE,YAAY,CAAC;IAC7B,uBAAuB,EAAE,KAAK,CAAC;IAC/B,aAAa,EAAE,qBAAqB,CAAC;IACrC,oBAAoB,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF,8BAAsB,sBAAsB,CAC1C,MAAM,CACN,SAAQ,cAAc,CAAC,MAAM,CAAC;aACd,gBAAgB,CAC9B,aAAa,EAAE,2BAA2B,EAC1C,MAAM,EAAE,oBAAoB,GAC3B,OAAO,CAAC,IAAI,CAAC;CACjB"}

package/dist/settlement/modularity/ProvableSettlementHook.js

@@ -0,0 +1,4 @@
+import { ProtocolModule } from "../../protocol/ProtocolModule";
+export class ProvableSettlementHook extends ProtocolModule {
+}
+//# sourceMappingURL=ProvableSettlementHook.js.map

package/dist/settlement/modularity/ProvableSettlementHook.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProvableSettlementHook.js","sourceRoot":"","sources":["../../../src/settlement/modularity/ProvableSettlementHook.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAyB/D,MAAM,OAAgB,sBAEpB,SAAQ,cAAsB;CAK/B"}

package/dist/settlement/modularity/types.d.ts

@@ -0,0 +1,8 @@
+import { TypedClass } from "@proto-kit/common";
+import { ContractModule, SmartContractClassFromInterface } from "../ContractModule";
+import type { SettlementModulesRecord } from "../SettlementContractModule";
+export type InferContractType<Module extends TypedClass<ContractModule<any, any>>> = Module extends TypedClass<infer ConcreteModule> ? ConcreteModule extends ContractModule<infer Contract, any> ? Contract : never : never;
+export type GetContracts<SettlementModules extends SettlementModulesRecord> = {
+    [Key in keyof SettlementModules]: SmartContractClassFromInterface<InferContractType<SettlementModules[Key]>>;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/settlement/modularity/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/settlement/modularity/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/C,OAAO,EACL,cAAc,EACd,+BAA+B,EAChC,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AAE3E,MAAM,MAAM,iBAAiB,CAC3B,MAAM,SAAS,UAAU,CAAC,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,IAEnD,MAAM,SAAS,UAAU,CAAC,MAAM,cAAc,CAAC,GAC3C,cAAc,SAAS,cAAc,CAAC,MAAM,QAAQ,EAAE,GAAG,CAAC,GACxD,QAAQ,GACR,KAAK,GACP,KAAK,CAAC;AAEZ,MAAM,MAAM,YAAY,CAAC,iBAAiB,SAAS,uBAAuB,IAAI;KAC3E,GAAG,IAAI,MAAM,iBAAiB,GAAG,+BAA+B,CAC/D,iBAAiB,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAC1C;CACF,CAAC"}

package/dist/settlement/modularity/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/settlement/modularity/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/settlement/modularity/types.ts"],"names":[],"mappings":""}

package/dist/settlement/modules/NetworkStateSettlementModule.d.ts

@@ -0,0 +1,11 @@
+import { UInt64 } from "o1js";
+import { ProvableSettlementHook, SettlementHookInputs } from "../modularity/ProvableSettlementHook";
+import { SettlementSmartContract } from "../contracts/SettlementSmartContract";
+type NetworkStateSettlementModuleConfig = {
+    blocksPerL1Block: UInt64;
+};
+export declare class NetworkStateSettlementModule extends ProvableSettlementHook<NetworkStateSettlementModuleConfig> {
+    beforeSettlement(smartContract: SettlementSmartContract, { blockProof, fromNetworkState, toNetworkState, contractState, currentL1BlockHeight, }: SettlementHookInputs): Promise<void>;
+}
+export {};
+//# sourceMappingURL=NetworkStateSettlementModule.d.ts.map

package/dist/settlement/modules/NetworkStateSettlementModule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NetworkStateSettlementModule.d.ts","sourceRoot":"","sources":["../../../src/settlement/modules/NetworkStateSettlementModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAE9B,OAAO,EACL,sBAAsB,EACtB,oBAAoB,EACrB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AAE/E,KAAK,kCAAkC,GAAG;IACxC,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAGF,qBAAa,4BAA6B,SAAQ,sBAAsB,CAAC,kCAAkC,CAAC;IAC7F,gBAAgB,CAC3B,aAAa,EAAE,uBAAuB,EACtC,EACE,UAAU,EACV,gBAAgB,EAChB,cAAc,EACd,aAAa,EACb,oBAAoB,GACrB,EAAE,oBAAoB;CAiB1B"}

package/dist/settlement/modules/NetworkStateSettlementModule.js

@@ -0,0 +1,15 @@
+import { ProvableSettlementHook, } from "../modularity/ProvableSettlementHook";
+/* eslint-disable @typescript-eslint/no-unused-vars */
+export class NetworkStateSettlementModule extends ProvableSettlementHook {
+    async beforeSettlement(smartContract, { blockProof, fromNetworkState, toNetworkState, contractState, currentL1BlockHeight, }) {
+        const { lastSettlementL1BlockHeight } = contractState;
+        const blocksPerL1Block = this.config.blocksPerL1Block.toConstant();
+        const numL1Blocks = currentL1BlockHeight.sub(lastSettlementL1BlockHeight);
+        const expectedHeightDiff = numL1Blocks.toUInt64().mul(blocksPerL1Block);
+        const actualHeightDiff = toNetworkState.block.height.sub(fromNetworkState.block.height);
+        const acceptableDerivation = numL1Blocks.mul(1).div(10);
+        // TODO Check within bounds efficiently
+    }
+}
+/* eslint-enable @typescript-eslint/no-unused-vars */
+//# sourceMappingURL=NetworkStateSettlementModule.js.map

package/dist/settlement/modules/NetworkStateSettlementModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NetworkStateSettlementModule.js","sourceRoot":"","sources":["../../../src/settlement/modules/NetworkStateSettlementModule.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,sBAAsB,GAEvB,MAAM,sCAAsC,CAAC;AAO9C,sDAAsD;AACtD,MAAM,OAAO,4BAA6B,SAAQ,sBAA0D;IACnG,KAAK,CAAC,gBAAgB,CAC3B,aAAsC,EACtC,EACE,UAAU,EACV,gBAAgB,EAChB,cAAc,EACd,aAAa,EACb,oBAAoB,GACC;QAEvB,MAAM,EAAE,2BAA2B,EAAE,GAAG,aAAa,CAAC;QAEtD,MAAM,gBAAgB,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,UAAU,EAAE,CAAC;QAEnE,MAAM,WAAW,GAAG,oBAAoB,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;QAC1E,MAAM,kBAAkB,GAAG,WAAW,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QAExE,MAAM,gBAAgB,GAAG,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CACtD,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAC9B,CAAC;QAEF,MAAM,oBAAoB,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAExD,uCAAuC;IACzC,CAAC;CACF;AAED,qDAAqD"}

package/dist/state/State.d.ts

@@ -0,0 +1,68 @@
+import { Field, type FlexibleProvablePure } from "o1js";
+import { Path } from "../model/Path";
+import { Option } from "../model/Option";
+import { StateServiceProvider } from "./StateServiceProvider";
+export declare class WithPath {
+    path?: Field;
+    hasPathOrFail(): asserts this is {
+        path: Path;
+    };
+}
+export declare class WithStateServiceProvider {
+    stateServiceProvider?: StateServiceProvider;
+    hasStateServiceOrFail(): asserts this is {
+        stateServiceProvider: StateServiceProvider;
+    };
+}
+declare const State_base: import("ts-mixer/dist/types/types").Class<any[], WithPath & WithStateServiceProvider, typeof WithPath & typeof WithStateServiceProvider>;
+/**
+ * Utilities for runtime module state, such as get/set
+ */
+export declare class State<Value> extends State_base {
+    valueType: FlexibleProvablePure<Value>;
+    /**
+     * Creates a new state wrapper for the provided value type.
+     *
+     * @param valueType - Type of value to be stored (e.g. UInt64, Struct, ...)
+     * @returns New state for the given value type.
+     */
+    static from<Value>(valueType: FlexibleProvablePure<Value>): State<Value>;
+    constructor(valueType: FlexibleProvablePure<Value>);
+    private stateType;
+    /**
+     * Returns the state that is currently the current state tree
+     * value: The value-fields, or if not state was found, dummy values
+     * isSome: Whether the values where found in the state or not
+     * (Basically, whether the value-fields are dummy values or actual values
+     * @private
+     */
+    private getState;
+    /**
+     * Provides an in-circuit witness for the current state representation,
+     * and constructs an Option out of it.
+     *
+     * @returns Optional value of the current state
+     */
+    private witnessFromState;
+    /**
+     * Retrieves the current state and creates a state transition
+     * anchoring the use of the current state value in the circuit.
+     *
+     * @returns Option representation of the current state.
+     */
+    get(): Promise<Option<Value>>;
+    /**
+     * 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.
+     *
+     * @param value - Value to be set as the current state
+     */
+    set(value: Value): Promise<void>;
+}
+export {};
+//# sourceMappingURL=State.d.ts.map

package/dist/state/State.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"State.d.ts","sourceRoot":"","sources":["../../src/state/State.ts"],"names":[],"mappings":"AACA,OAAO,EAAQ,KAAK,EAAY,KAAK,oBAAoB,EAAU,MAAM,MAAM,CAAC;AAIhF,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAGzC,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAG9D,qBAAa,QAAQ;IACZ,IAAI,CAAC,EAAE,KAAK,CAAC;IAEb,aAAa,IAAI,OAAO,CAAC,IAAI,IAAI;QAAE,IAAI,EAAE,IAAI,CAAA;KAAE;CAOvD;AAED,qBAAa,wBAAwB;IAC5B,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAE5C,qBAAqB,IAAI,OAAO,CAAC,IAAI,IAAI;QAC9C,oBAAoB,EAAE,oBAAoB,CAAC;KAC5C;CAOF;;AAED;;GAEG;AACH,qBAAa,KAAK,CAAC,KAAK,CAAE,SAAQ,UAAyC;IAW/C,SAAS,EAAE,oBAAoB,CAAC,KAAK,CAAC;IAVhE;;;;;OAKG;WACW,IAAI,CAAC,KAAK,EAAE,SAAS,EAAE,oBAAoB,CAAC,KAAK,CAAC;gBAItC,SAAS,EAAE,oBAAoB,CAAC,KAAK,CAAC;IAIhE,OAAO,CAAC,SAAS,CAGX;IAEN;;;;;;OAMG;YACW,QAAQ;IAyCtB;;;;;OAKG;YACW,gBAAgB;IAW9B;;;;;OAKG;IACU,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAc1C;;;;;;;;;;OAUG;IACU,GAAG,CAAC,KAAK,EAAE,KAAK;CAiB9B"}

package/dist/state/State.js

@@ -0,0 +1,130 @@
+import { Mixin } from "ts-mixer";
+import { Bool, Provable, Struct } from "o1js";
+import { container } from "tsyringe";
+import { dummyValue } from "@proto-kit/common";
+import { Option } from "../model/Option";
+import { StateTransition } from "../model/StateTransition";
+import { RuntimeMethodExecutionContext } from "./context/RuntimeMethodExecutionContext";
+export class WithPath {
+    hasPathOrFail() {
+        if (!this.path) {
+            throw new Error("Could not find 'path', did you forget to add '@state' to your state property?");
+        }
+    }
+}
+export class WithStateServiceProvider {
+    hasStateServiceOrFail() {
+        if (!this.stateServiceProvider) {
+            throw new Error("Could not find 'stateServiceProvider', did you forget to add '@state' to your state property?");
+        }
+    }
+}
+/**
+ * Utilities for runtime module state, such as get/set
+ */
+export class State extends Mixin(WithPath, WithStateServiceProvider) {
+    /**
+     * Creates a new state wrapper for the provided value type.
+     *
+     * @param valueType - Type of value to be stored (e.g. UInt64, Struct, ...)
+     * @returns New state for the given value type.
+     */
+    static from(valueType) {
+        return new State(valueType);
+    }
+    constructor(valueType) {
+        super();
+        this.valueType = valueType;
+        this.stateType = class StateType extends Struct({
+            value: this.valueType,
+            isSome: Bool,
+        }) {
+        };
+    }
+    /**
+     * Returns the state that is currently the current state tree
+     * value: The value-fields, or if not state was found, dummy values
+     * isSome: Whether the values where found in the state or not
+     * (Basically, whether the value-fields are dummy values or actual values
+     * @private
+     */
+    async getState() {
+        this.hasStateServiceOrFail();
+        this.hasPathOrFail();
+        const { path, stateServiceProvider, valueType } = this;
+        const { stateTransitions } = container
+            .resolve(RuntimeMethodExecutionContext)
+            .current().result;
+        // TODO Use Stateservice for this
+        // First try to find a match inside already created stateTransitions
+        let previousMutatingTransitions = [];
+        previousMutatingTransitions = stateTransitions.filter((transition) => transition.path.equals(path).and(transition.to.isSome).toBoolean());
+        const pmtLength = previousMutatingTransitions.length;
+        let value = pmtLength > 0
+            ? // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+                previousMutatingTransitions[pmtLength - 1].to.value
+            : undefined;
+        if (value !== undefined) {
+            return { value, isSome: Bool(true) };
+        }
+        // If the value is still undefined, look it up in the stateService
+        const fields = await stateServiceProvider.stateService.get(path);
+        if (fields) {
+            // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+            value = valueType.fromFields(fields);
+        }
+        if (value !== undefined) {
+            return { value, isSome: Bool(true) };
+        }
+        return { value: dummyValue(valueType), isSome: Bool(false) };
+    }
+    /**
+     * Provides an in-circuit witness for the current state representation,
+     * and constructs an Option out of it.
+     *
+     * @returns Optional value of the current state
+     */
+    async witnessFromState() {
+        // get the value from storage, or return a dummy value instead
+        // also check if the value exists in the storage or not
+        const { value, isSome } = await Provable.witnessAsync(this.stateType, async () => await this.getState());
+        return Option.from(isSome, value, this.valueType);
+    }
+    /**
+     * Retrieves the current state and creates a state transition
+     * anchoring the use of the current state value in the circuit.
+     *
+     * @returns Option representation of the current state.
+     */
+    async get() {
+        const option = await this.witnessFromState();
+        this.hasPathOrFail();
+        const stateTransition = StateTransition.from(this.path, option);
+        container
+            .resolve(RuntimeMethodExecutionContext)
+            .addStateTransition(stateTransition);
+        return option;
+    }
+    /**
+     * 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.
+     *
+     * @param value - Value to be set as the current state
+     */
+    async set(value) {
+        // link the transition to the current state
+        const fromOption = await this.witnessFromState();
+        const toOption = Option.fromValue(value, this.valueType);
+        this.hasPathOrFail();
+        const stateTransition = StateTransition.fromTo(this.path, fromOption, toOption);
+        container
+            .resolve(RuntimeMethodExecutionContext)
+            .addStateTransition(stateTransition);
+    }
+}
+//# sourceMappingURL=State.js.map

package/dist/state/State.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"State.js","sourceRoot":"","sources":["../../src/state/State.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,IAAI,EAAS,QAAQ,EAA6B,MAAM,EAAE,MAAM,MAAM,CAAC;AAChF,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAG/C,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAG3D,OAAO,EAAE,6BAA6B,EAAE,MAAM,yCAAyC,CAAC;AAExF,MAAM,OAAO,QAAQ;IAGZ,aAAa;QAClB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACd,MAAM,IAAI,KAAK,CACb,+EAA+E,CAChF,CAAC;SACH;IACH,CAAC;CACF;AAED,MAAM,OAAO,wBAAwB;IAG5B,qBAAqB;QAG1B,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE;YAC9B,MAAM,IAAI,KAAK,CACb,+FAA+F,CAChG,CAAC;SACH;IACH,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,KAAa,SAAQ,KAAK,CAAC,QAAQ,EAAE,wBAAwB,CAAC;IACzE;;;;;OAKG;IACI,MAAM,CAAC,IAAI,CAAQ,SAAsC;QAC9D,OAAO,IAAI,KAAK,CAAQ,SAAS,CAAC,CAAC;IACrC,CAAC;IAED,YAA0B,SAAsC;QAC9D,KAAK,EAAE,CAAC;QADgB,cAAS,GAAT,SAAS,CAA6B;QAIxD,cAAS,GAAG,MAAM,SAAU,SAAQ,MAAM,CAAC;YACjD,KAAK,EAAE,IAAI,CAAC,SAAS;YACrB,MAAM,EAAE,IAAI;SACb,CAAC;SAAG,CAAC;IALN,CAAC;IAOD;;;;;;OAMG;IACK,KAAK,CAAC,QAAQ;QACpB,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAC7B,IAAI,CAAC,aAAa,EAAE,CAAC;QAErB,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;QAEvD,MAAM,EAAE,gBAAgB,EAAE,GAAG,SAAS;aACnC,OAAO,CAAC,6BAA6B,CAAC;aACtC,OAAO,EAAE,CAAC,MAAM,CAAC;QAEpB,iCAAiC;QACjC,oEAAoE;QACpE,IAAI,2BAA2B,GAA2B,EAAE,CAAC;QAC7D,2BAA2B,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CACnE,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,CACnE,CAAC;QACF,MAAM,SAAS,GAAG,2BAA2B,CAAC,MAAM,CAAC;QAErD,IAAI,KAAK,GACP,SAAS,GAAG,CAAC;YACX,CAAC,CAAC,yEAAyE;gBACxE,2BAA2B,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,KAAe;YAChE,CAAC,CAAC,SAAS,CAAC;QAEhB,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;SACtC;QAED,kEAAkE;QAClE,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACjE,IAAI,MAAM,EAAE;YACV,yEAAyE;YACzE,KAAK,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,CAAU,CAAC;SAC/C;QAED,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;SACtC;QACD,OAAO,EAAE,KAAK,EAAE,UAAU,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,gBAAgB;QAC5B,8DAA8D;QAC9D,uDAAuD;QACvD,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,QAAQ,CAAC,YAAY,CACnD,IAAI,CAAC,SAAS,EACd,KAAK,IAAI,EAAE,CAAC,MAAM,IAAI,CAAC,QAAQ,EAAE,CAClC,CAAC;QAEF,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,GAAG;QACd,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAE7C,IAAI,CAAC,aAAa,EAAE,CAAC;QAErB,MAAM,eAAe,GAAG,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAEhE,SAAS;aACN,OAAO,CAAC,6BAA6B,CAAC;aACtC,kBAAkB,CAAC,eAAe,CAAC,CAAC;QAEvC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,GAAG,CAAC,KAAY;QAC3B,2CAA2C;QAC3C,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACjD,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAEzD,IAAI,CAAC,aAAa,EAAE,CAAC;QAErB,MAAM,eAAe,GAAG,eAAe,CAAC,MAAM,CAC5C,IAAI,CAAC,IAAI,EACT,UAAU,EACV,QAAQ,CACT,CAAC;QAEF,SAAS;aACN,OAAO,CAAC,6BAA6B,CAAC;aACtC,kBAAkB,CAAC,eAAe,CAAC,CAAC;IACzC,CAAC;CACF"}