@proto-kit/protocol 0.1.1-develop.0

package/dist/settlement/contracts/BridgeContract.js

@@ -0,0 +1,164 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { AccountUpdate, Bool, Field, method, Poseidon, Provable, PublicKey, State, state, Struct, TokenContractV2, TokenId, } from "o1js";
+import { noop, range } from "@proto-kit/common";
+import { OUTGOING_MESSAGE_BATCH_SIZE, OutgoingMessageArgumentBatch, } from "../messages/OutgoingMessageArgument";
+import { Path } from "../../model/Path";
+import { Withdrawal } from "../messages/Withdrawal";
+// Equal to WithdrawalKey
+export class OutgoingMessageKey extends Struct({
+    index: Field,
+    tokenId: Field,
+}) {
+}
+export class BridgeContractBase extends TokenContractV2 {
+    /**
+     * 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
+     *
+     * @returns Creates and returns an account update deploying the bridge contract
+     */
+    async deployProvable(verificationKey, signedSettlement, permissions, settlementContractAddress) {
+        const accountUpdate = this.self;
+        if (!signedSettlement) {
+            if (verificationKey === undefined) {
+                throw new Error("Verification Key not provided, can't deploy");
+            }
+            accountUpdate.account.verificationKey.set(verificationKey);
+        }
+        accountUpdate.requireSignature();
+        this.account.permissions.set(permissions);
+        range(0, 8).forEach((i) => {
+            accountUpdate.update.appState[i] = {
+                isSome: Bool(true),
+                value: Field(0),
+            };
+        });
+        this.settlementContractAddress.set(settlementContractAddress);
+        accountUpdate.body.mayUseToken = {
+            // Set to true for custom tokens only
+            inheritFromParent: accountUpdate.tokenId.equals(TokenId.default).not(),
+            parentsOwnToken: Bool(false),
+        };
+        return accountUpdate;
+    }
+    async approveBase() {
+        noop();
+    }
+    async updateStateRootBase(root) {
+        this.stateRoot.set(root);
+        const settlementContractAddress = this.settlementContractAddress.getAndRequireEquals();
+        const SettlementContractClass = BridgeContractBase.args.SettlementContract;
+        if (SettlementContractClass === undefined) {
+            throw new Error("Settlement Contract class hasn't been set yet, something is wrong with your module composition");
+        }
+        const settlementContract = new SettlementContractClass(settlementContractAddress);
+        const accountUpdate = settlementContract.assertStateRoot(root);
+        this.approve(accountUpdate);
+    }
+    async rollupOutgoingMessagesBase(batch) {
+        let counter = this.outgoingMessageCursor.getAndRequireEquals();
+        const stateRoot = this.stateRoot.getAndRequireEquals();
+        const [withdrawalModule, withdrawalStateName] = BridgeContractBase.args.withdrawalStatePath;
+        const mapPath = Path.fromProperty(withdrawalModule, withdrawalStateName);
+        // Count account creation fee to return later, so that the sender can fund
+        // those accounts with a separate AU
+        let accountCreationFeePaid = Field(0);
+        for (let i = 0; i < OUTGOING_MESSAGE_BATCH_SIZE; i++) {
+            const args = batch.arguments[i];
+            // Check witness
+            const path = Path.fromKey(mapPath, OutgoingMessageKey, {
+                index: counter,
+                tokenId: this.tokenId,
+            });
+            // Process message
+            const { address, amount } = args.value;
+            const isDummy = address.equals(this.address);
+            args.witness
+                .checkMembership(stateRoot, path, Poseidon.hash(Withdrawal.toFields(args.value)))
+                .or(isDummy)
+                .assertTrue("Provided Withdrawal witness not valid");
+            const tokenAu = this.internal.mint({ address, amount });
+            const isNewAccount = tokenAu.account.isNew.getAndRequireEquals();
+            accountCreationFeePaid = accountCreationFeePaid.add(Provable.if(isNewAccount, Field(1e9), Field(0)));
+            counter = counter.add(Provable.if(isDummy, Field(0), Field(1)));
+        }
+        this.outgoingMessageCursor.set(counter);
+        return accountCreationFeePaid;
+    }
+    async redeemBase(additionUpdate) {
+        additionUpdate.body.tokenId.assertEquals(this.tokenId, "Tokenid not same as this bridging contract's tokenId");
+        additionUpdate.body.balanceChange.sgn
+            .isPositive()
+            .assertTrue("Sign not correct");
+        const amount = additionUpdate.body.balanceChange.magnitude;
+        // Burn tokens
+        this.internal.burn({
+            address: additionUpdate.publicKey,
+            amount,
+        });
+        // Inherit from parent for custom tokens
+        additionUpdate.body.mayUseToken = {
+            inheritFromParent: this.tokenId.equals(TokenId.default).not(),
+            parentsOwnToken: Bool(false),
+        };
+        // Send mina
+        this.approve(additionUpdate);
+        this.balance.subInPlace(amount);
+    }
+}
+export class BridgeContract extends BridgeContractBase {
+    constructor() {
+        super(...arguments);
+        this.settlementContractAddress = State();
+        this.stateRoot = State();
+        this.outgoingMessageCursor = State();
+    }
+    async updateStateRoot(root) {
+        return await this.updateStateRootBase(root);
+    }
+    async rollupOutgoingMessages(batch) {
+        return await this.rollupOutgoingMessagesBase(batch);
+    }
+    async redeem(additionUpdate) {
+        return await this.redeemBase(additionUpdate);
+    }
+}
+__decorate([
+    state(PublicKey),
+    __metadata("design:type", Object)
+], BridgeContract.prototype, "settlementContractAddress", void 0);
+__decorate([
+    state(Field),
+    __metadata("design:type", Object)
+], BridgeContract.prototype, "stateRoot", void 0);
+__decorate([
+    state(Field),
+    __metadata("design:type", Object)
+], BridgeContract.prototype, "outgoingMessageCursor", void 0);
+__decorate([
+    method,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Field]),
+    __metadata("design:returntype", Promise)
+], BridgeContract.prototype, "updateStateRoot", null);
+__decorate([
+    method.returns(Field),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [OutgoingMessageArgumentBatch]),
+    __metadata("design:returntype", Promise)
+], BridgeContract.prototype, "rollupOutgoingMessages", null);
+__decorate([
+    method,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [AccountUpdate]),
+    __metadata("design:returntype", Promise)
+], BridgeContract.prototype, "redeem", null);
+//# sourceMappingURL=BridgeContract.js.map

package/dist/settlement/contracts/BridgeContract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BridgeContract.js","sourceRoot":"","sources":["../../../src/settlement/contracts/BridgeContract.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EACL,aAAa,EACb,IAAI,EACJ,KAAK,EACL,MAAM,EAEN,QAAQ,EACR,QAAQ,EACR,SAAS,EAET,KAAK,EACL,KAAK,EACL,MAAM,EACN,eAAe,EACf,OAAO,GAER,MAAM,MAAM,CAAC;AACd,OAAO,EAAE,IAAI,EAAE,KAAK,EAAc,MAAM,mBAAmB,CAAC;AAE5D,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,GAC7B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAuBpD,yBAAyB;AACzB,MAAM,OAAO,kBAAmB,SAAQ,MAAM,CAAC;IAC7C,KAAK,EAAE,KAAK;IACZ,OAAO,EAAE,KAAK;CACf,CAAC;CAAG;AAEL,MAAM,OAAgB,kBAAmB,SAAQ,eAAe;IAc9D;;;;;OAKG;IACI,KAAK,CAAC,cAAc,CACzB,eAA4C,EAC5C,gBAAyB,EACzB,WAAwB,EACxB,yBAAoC;QAEpC,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC;QAEhC,IAAI,CAAC,gBAAgB,EAAE;YACrB,IAAI,eAAe,KAAK,SAAS,EAAE;gBACjC,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;aAChE;YACD,aAAa,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;SAC5D;QAED,aAAa,CAAC,gBAAgB,EAAE,CAAC;QACjC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAE1C,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACxB,aAAa,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG;gBACjC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC;gBAClB,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;aAChB,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;QAE9D,aAAa,CAAC,IAAI,CAAC,WAAW,GAAG;YAC/B,qCAAqC;YACrC,iBAAiB,EAAE,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE;YACtE,eAAe,EAAE,IAAI,CAAC,KAAK,CAAC;SAC7B,CAAC;QAEF,OAAO,aAAa,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,WAAW;QACtB,IAAI,EAAE,CAAC;IACT,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,IAAW;QAC1C,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAEzB,MAAM,yBAAyB,GAC7B,IAAI,CAAC,yBAAyB,CAAC,mBAAmB,EAAE,CAAC;QACvD,MAAM,uBAAuB,GAAG,kBAAkB,CAAC,IAAI,CAAC,kBAAkB,CAAC;QAC3E,IAAI,uBAAuB,KAAK,SAAS,EAAE;YACzC,MAAM,IAAI,KAAK,CACb,gGAAgG,CACjG,CAAC;SACH;QACD,MAAM,kBAAkB,GAAG,IAAI,uBAAuB,CACpD,yBAAyB,CAC1B,CAAC;QACF,MAAM,aAAa,GAAG,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAC/D,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IAC9B,CAAC;IAEM,KAAK,CAAC,0BAA0B,CACrC,KAAmC;QAEnC,IAAI,OAAO,GAAG,IAAI,CAAC,qBAAqB,CAAC,mBAAmB,EAAE,CAAC;QAC/D,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,mBAAmB,EAAE,CAAC;QAEvD,MAAM,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,GAC3C,kBAAkB,CAAC,IAAI,CAAC,mBAAmB,CAAC;QAC9C,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,CAAC;QAEzE,0EAA0E;QAC1E,oCAAoC;QACpC,IAAI,sBAAsB,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAEtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,2BAA2B,EAAE,CAAC,EAAE,EAAE;YACpD,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAEhC,gBAAgB;YAChB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,kBAAkB,EAAE;gBACrD,KAAK,EAAE,OAAO;gBACd,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAC,CAAC;YAEH,kBAAkB;YAClB,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;YACvC,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAE7C,IAAI,CAAC,OAAO;iBACT,eAAe,CACd,SAAS,EACT,IAAI,EACJ,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAC/C;iBACA,EAAE,CAAC,OAAO,CAAC;iBACX,UAAU,CAAC,uCAAuC,CAAC,CAAC;YAEvD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;YACxD,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,mBAAmB,EAAE,CAAC;YAEjE,sBAAsB,GAAG,sBAAsB,CAAC,GAAG,CACjD,QAAQ,CAAC,EAAE,CAAC,YAAY,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAChD,CAAC;YAEF,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACjE;QAED,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAExC,OAAO,sBAAsB,CAAC;IAChC,CAAC;IAES,KAAK,CAAC,UAAU,CAAC,cAA6B;QACtD,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CACtC,IAAI,CAAC,OAAO,EACZ,sDAAsD,CACvD,CAAC;QACF,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG;aAClC,UAAU,EAAE;aACZ,UAAU,CAAC,kBAAkB,CAAC,CAAC;QAClC,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC;QAE3D,cAAc;QACd,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjB,OAAO,EAAE,cAAc,CAAC,SAAS;YACjC,MAAM;SACP,CAAC,CAAC;QAEH,wCAAwC;QACxC,cAAc,CAAC,IAAI,CAAC,WAAW,GAAG;YAChC,iBAAiB,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE;YAC7D,eAAe,EAAE,IAAI,CAAC,KAAK,CAAC;SAC7B,CAAC;QAEF,YAAY;QACZ,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAC7B,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;CACF;AAED,MAAM,OAAO,cACX,SAAQ,kBAAkB;IAD5B;;QAI2B,8BAAyB,GAAG,KAAK,EAAa,CAAC;QAEnD,cAAS,GAAG,KAAK,EAAS,CAAC;QAE3B,0BAAqB,GAAG,KAAK,EAAS,CAAC;IAkB9D,CAAC;IAfc,AAAN,KAAK,CAAC,eAAe,CAAC,IAAW;QACtC,OAAO,MAAM,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC;IAGY,AAAN,KAAK,CAAC,sBAAsB,CACjC,KAAmC;QAEnC,OAAO,MAAM,IAAI,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC;IACtD,CAAC;IAGY,AAAN,KAAK,CAAC,MAAM,CAAC,cAA6B;QAC/C,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;IAC/C,CAAC;CACF;AAtB0B;IAAxB,KAAK,CAAC,SAAS,CAAC;;iEAAuD;AAEnD;IAApB,KAAK,CAAC,KAAK,CAAC;;iDAAmC;AAE3B;IAApB,KAAK,CAAC,KAAK,CAAC;;6DAA+C;AAG/C;IADZ,MAAM;;qCAC4B,KAAK;;qDAEvC;AAGY;IADZ,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;;qCAEb,4BAA4B;;4DAGpC;AAGY;IADZ,MAAM;;qCAC6B,aAAa;;4CAEhD"}

package/dist/settlement/contracts/BridgeContractProtocolModule.d.ts

@@ -0,0 +1,14 @@
+import { CompileRegistry } from "@proto-kit/common";
+import { ContractModule } from "../ContractModule";
+import { BridgeContract, BridgeContractType } from "./BridgeContract";
+export type BridgeContractConfig = {
+    withdrawalStatePath: `${string}.${string}`;
+    withdrawalEventName: string;
+};
+export declare class BridgeContractProtocolModule extends ContractModule<BridgeContractType, BridgeContractConfig> {
+    contractFactory(): typeof BridgeContract;
+    compile(registry: CompileRegistry): Promise<{
+        BridgeContract: import("@proto-kit/common").CompileArtifact;
+    }>;
+}
+//# sourceMappingURL=BridgeContractProtocolModule.d.ts.map

package/dist/settlement/contracts/BridgeContractProtocolModule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BridgeContractProtocolModule.d.ts","sourceRoot":"","sources":["../../../src/settlement/contracts/BridgeContractProtocolModule.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEnD,OAAO,EACL,cAAc,EAEd,kBAAkB,EACnB,MAAM,kBAAkB,CAAC;AAE1B,MAAM,MAAM,oBAAoB,GAAG;IACjC,mBAAmB,EAAE,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;IAC3C,mBAAmB,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF,qBACa,4BAA6B,SAAQ,cAAc,CAC9D,kBAAkB,EAClB,oBAAoB,CACrB;IACQ,eAAe;IAgBT,OAAO,CAAC,QAAQ,EAAE,eAAe;;;CAK/C"}

package/dist/settlement/contracts/BridgeContractProtocolModule.js

@@ -0,0 +1,30 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { injectable } from "tsyringe";
+import { ContractModule } from "../ContractModule";
+import { BridgeContract, BridgeContractBase, } from "./BridgeContract";
+export let BridgeContractProtocolModule = class BridgeContractProtocolModule extends ContractModule {
+    contractFactory() {
+        const { config } = this;
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+        const withdrawalStatePathSplit = config.withdrawalStatePath.split(".");
+        BridgeContractBase.args = {
+            withdrawalStatePath: withdrawalStatePathSplit,
+            SettlementContract: BridgeContractBase.args?.SettlementContract,
+        };
+        return BridgeContract;
+    }
+    async compile(registry) {
+        return {
+            BridgeContract: await registry.compile(BridgeContract),
+        };
+    }
+};
+BridgeContractProtocolModule = __decorate([
+    injectable()
+], BridgeContractProtocolModule);
+//# sourceMappingURL=BridgeContractProtocolModule.js.map

package/dist/settlement/contracts/BridgeContractProtocolModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BridgeContractProtocolModule.js","sourceRoot":"","sources":["../../../src/settlement/contracts/BridgeContractProtocolModule.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAGtC,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEnD,OAAO,EACL,cAAc,EACd,kBAAkB,GAEnB,MAAM,kBAAkB,CAAC;AAQnB,WAAM,4BAA4B,GAAlC,MAAM,4BAA6B,SAAQ,cAGjD;IACQ,eAAe;QACpB,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QACxB,yEAAyE;QACzE,MAAM,wBAAwB,GAAG,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC,GAAG,CAGpE,CAAC;QAEF,kBAAkB,CAAC,IAAI,GAAG;YACxB,mBAAmB,EAAE,wBAAwB;YAC7C,kBAAkB,EAAE,kBAAkB,CAAC,IAAI,EAAE,kBAAkB;SAChE,CAAC;QAEF,OAAO,cAAc,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,QAAyB;QAC5C,OAAO;YACL,cAAc,EAAE,MAAM,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC;SACvD,CAAC;IACJ,CAAC;CACF,CAAA;AAzBY,4BAA4B;IADxC,UAAU,EAAE;GACA,4BAA4B,CAyBxC"}

package/dist/settlement/contracts/DispatchContractProtocolModule.d.ts

@@ -0,0 +1,21 @@
+import { CompileRegistry } from "@proto-kit/common";
+import { RuntimeLike } from "../../model/RuntimeLike";
+import { ContractModule, SmartContractClassFromInterface } from "../ContractModule";
+import { DispatchContractType } from "./DispatchSmartContract";
+export type DispatchContractConfig = {
+    incomingMessagesMethods: Record<string, `${string}.${string}`>;
+};
+export declare class DispatchContractProtocolModule extends ContractModule<DispatchContractType, DispatchContractConfig> {
+    private readonly runtime;
+    constructor(runtime: RuntimeLike);
+    eventsDefinition(): {
+        "token-bridge-added": typeof import("./TokenBridgeTree").TokenBridgeTreeAddition;
+        "incoming-message-placeholder": typeof import("o1js/dist/node/lib/provable/field").Field & ((x: string | number | bigint | import("o1js/dist/node/lib/provable/field").Field | import("o1js/dist/node/lib/provable/core/fieldvar").FieldVar | import("o1js/dist/node/lib/provable/core/fieldvar").FieldConst) => import("o1js/dist/node/lib/provable/field").Field);
+    };
+    private checkConfigIntegrity;
+    contractFactory(): SmartContractClassFromInterface<DispatchContractType>;
+    compile(registry: CompileRegistry): Promise<{
+        DispatchSmartContract: import("@proto-kit/common").CompileArtifact;
+    }>;
+}
+//# sourceMappingURL=DispatchContractProtocolModule.d.ts.map

package/dist/settlement/contracts/DispatchContractProtocolModule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DispatchContractProtocolModule.d.ts","sourceRoot":"","sources":["../../../src/settlement/contracts/DispatchContractProtocolModule.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,EAAE,WAAW,EAA0B,MAAM,yBAAyB,CAAC;AAC9E,OAAO,EACL,cAAc,EACd,+BAA+B,EAChC,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAEL,oBAAoB,EAErB,MAAM,yBAAyB,CAAC;AAEjC,MAAM,MAAM,sBAAsB,GAAG;IACnC,uBAAuB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC,CAAC;CAChE,CAAC;AAEF,qBACa,8BAA+B,SAAQ,cAAc,CAChE,oBAAoB,EACpB,sBAAsB,CACvB;IACuC,OAAO,CAAC,QAAQ,CAAC,OAAO;gBAAP,OAAO,EAAE,WAAW;IAIpE,gBAAgB;;;;IAKvB,OAAO,CAAC,oBAAoB;IAcrB,eAAe,IAAI,+BAA+B,CAAC,oBAAoB,CAAC;IAgBlE,OAAO,CAAC,QAAQ,EAAE,eAAe;;;CAQ/C"}

package/dist/settlement/contracts/DispatchContractProtocolModule.js

@@ -0,0 +1,57 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+import { inject, injectable } from "tsyringe";
+import { PublicKey } from "o1js";
+import { ContractModule, } from "../ContractModule";
+import { DispatchSmartContract, DispatchSmartContractBase, } from "./DispatchSmartContract";
+export let DispatchContractProtocolModule = class DispatchContractProtocolModule extends ContractModule {
+    constructor(runtime) {
+        super();
+        this.runtime = runtime;
+    }
+    eventsDefinition() {
+        return new DispatchSmartContract(PublicKey.empty())
+            .events;
+    }
+    checkConfigIntegrity(incomingMessagesMethods, runtimeMethodIds) {
+        const missing = Object.values(incomingMessagesMethods).filter((method) => runtimeMethodIds[method] === undefined);
+        if (missing.length > 0) {
+            throw new Error(`Incoming messages config references a unknown methods: [${missing}]`);
+        }
+    }
+    contractFactory() {
+        const { incomingMessagesMethods } = this.config;
+        const methodIdMappings = this.runtime.methodIdResolver.methodIdMap();
+        this.checkConfigIntegrity(incomingMessagesMethods, methodIdMappings);
+        DispatchSmartContractBase.args = {
+            incomingMessagesPaths: incomingMessagesMethods,
+            methodIdMappings,
+            settlementContractClass: DispatchSmartContractBase.args?.settlementContractClass,
+        };
+        return DispatchSmartContract;
+    }
+    async compile(registry) {
+        if (DispatchSmartContractBase.args.settlementContractClass === undefined) {
+            throw new Error("Reference to Settlement Contract not set");
+        }
+        return {
+            DispatchSmartContract: await registry.compile(DispatchSmartContract),
+        };
+    }
+};
+DispatchContractProtocolModule = __decorate([
+    injectable(),
+    __param(0, inject("Runtime")),
+    __metadata("design:paramtypes", [Object])
+], DispatchContractProtocolModule);
+//# sourceMappingURL=DispatchContractProtocolModule.js.map

package/dist/settlement/contracts/DispatchContractProtocolModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DispatchContractProtocolModule.js","sourceRoot":"","sources":["../../../src/settlement/contracts/DispatchContractProtocolModule.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAIjC,OAAO,EACL,cAAc,GAEf,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EACL,qBAAqB,EAErB,yBAAyB,GAC1B,MAAM,yBAAyB,CAAC;AAO1B,WAAM,8BAA8B,GAApC,MAAM,8BAA+B,SAAQ,cAGnD;IACC,YAAuD,OAAoB;QACzE,KAAK,EAAE,CAAC;QAD6C,YAAO,GAAP,OAAO,CAAa;IAE3E,CAAC;IAEM,gBAAgB;QACrB,OAAO,IAAI,qBAAqB,CAAC,SAAS,CAAC,KAAK,EAAoB,CAAC;aAClE,MAAM,CAAC;IACZ,CAAC;IAEO,oBAAoB,CAC1B,uBAA8D,EAC9D,gBAAwC;QAExC,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAC,MAAM,CAC3D,CAAC,MAAM,EAAE,EAAE,CAAC,gBAAgB,CAAC,MAAM,CAAC,KAAK,SAAS,CACnD,CAAC;QACF,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACtB,MAAM,IAAI,KAAK,CACb,2DAA2D,OAAO,GAAG,CACtE,CAAC;SACH;IACH,CAAC;IAEM,eAAe;QACpB,MAAM,EAAE,uBAAuB,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;QAChD,MAAM,gBAAgB,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,WAAW,EAAE,CAAC;QAErE,IAAI,CAAC,oBAAoB,CAAC,uBAAuB,EAAE,gBAAgB,CAAC,CAAC;QAErE,yBAAyB,CAAC,IAAI,GAAG;YAC/B,qBAAqB,EAAE,uBAAuB;YAC9C,gBAAgB;YAChB,uBAAuB,EACrB,yBAAyB,CAAC,IAAI,EAAE,uBAAuB;SAC1D,CAAC;QAEF,OAAO,qBAAqB,CAAC;IAC/B,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,QAAyB;QAC5C,IAAI,yBAAyB,CAAC,IAAI,CAAC,uBAAuB,KAAK,SAAS,EAAE;YACxE,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;SAC7D;QACD,OAAO;YACL,qBAAqB,EAAE,MAAM,QAAQ,CAAC,OAAO,CAAC,qBAAqB,CAAC;SACrE,CAAC;IACJ,CAAC;CACF,CAAA;AAnDY,8BAA8B;IAD1C,UAAU,EAAE;IAKS,WAAA,MAAM,CAAC,SAAS,CAAC,CAAA;;GAJ1B,8BAA8B,CAmD1C"}

package/dist/settlement/contracts/DispatchSmartContract.d.ts

@@ -0,0 +1,44 @@
+import { Field, ProvableExtended, PublicKey, SmartContract, State, UInt64 } from "o1js";
+import { TypedClass } from "@proto-kit/common";
+import { RuntimeMethodIdMapping } from "../../model/RuntimeLike";
+import type { SettlementContractType } from "./SettlementSmartContract";
+import { TokenBridgeAttestation, TokenBridgeTreeAddition } from "./TokenBridgeTree";
+export declare const ACTIONS_EMPTY_HASH: import("o1js/dist/node/lib/provable/field").Field;
+export interface DispatchContractType {
+    updateMessagesHash: (executedMessagesHash: Field, newPromisedMessagesHash: Field) => Promise<void>;
+    initialize: (settlementContract: PublicKey) => Promise<void>;
+    enableTokenDeposits: (tokenId: Field, bridgeContractAddress: PublicKey, settlementContractAddress: PublicKey) => Promise<void>;
+    promisedMessagesHash: State<Field>;
+}
+export declare abstract class DispatchSmartContractBase extends SmartContract {
+    static args: {
+        methodIdMappings: RuntimeMethodIdMapping;
+        incomingMessagesPaths: Record<string, `${string}.${string}`>;
+        settlementContractClass?: TypedClass<SettlementContractType> & typeof SmartContract;
+    };
+    events: {
+        "token-bridge-added": typeof TokenBridgeTreeAddition;
+        "incoming-message-placeholder": typeof import("o1js/dist/node/lib/provable/field").Field & ((x: string | number | bigint | import("o1js/dist/node/lib/provable/field").Field | import("o1js/dist/node/lib/provable/core/fieldvar").FieldVar | import("o1js/dist/node/lib/provable/core/fieldvar").FieldConst) => import("o1js/dist/node/lib/provable/field").Field);
+    };
+    abstract promisedMessagesHash: State<Field>;
+    abstract honoredMessagesHash: State<Field>;
+    abstract settlementContract: State<PublicKey>;
+    abstract tokenBridgeRoot: State<Field>;
+    abstract tokenBridgeCount: State<Field>;
+    protected updateMessagesHashBase(executedMessagesHash: Field, newPromisedMessagesHash: Field): void;
+    protected initializeBase(settlementContract: PublicKey): void;
+    protected dispatchMessage<Type>(methodId: Field, value: Type, valueType: ProvableExtended<Type>): void;
+    protected enableTokenDepositsBase(tokenId: Field, bridgeContractAddress: PublicKey, settlementContractAddress: PublicKey): Promise<void>;
+}
+export declare class DispatchSmartContract extends DispatchSmartContractBase implements DispatchContractType {
+    promisedMessagesHash: State<import("o1js/dist/node/lib/provable/field").Field>;
+    honoredMessagesHash: State<import("o1js/dist/node/lib/provable/field").Field>;
+    settlementContract: State<PublicKey>;
+    tokenBridgeRoot: State<import("o1js/dist/node/lib/provable/field").Field>;
+    tokenBridgeCount: State<import("o1js/dist/node/lib/provable/field").Field>;
+    enableTokenDeposits(tokenId: Field, bridgeContractAddress: PublicKey, settlementContractAddress: PublicKey): Promise<void>;
+    updateMessagesHash(executedMessagesHash: Field, newPromisedMessagesHash: Field): Promise<void>;
+    initialize(settlementContract: PublicKey): Promise<void>;
+    deposit(amount: UInt64, tokenId: Field, bridgingContract: PublicKey, bridgingContractAttestation: TokenBridgeAttestation, l2Receiver: PublicKey): Promise<void>;
+}
+//# sourceMappingURL=DispatchSmartContract.d.ts.map

package/dist/settlement/contracts/DispatchSmartContract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DispatchSmartContract.d.ts","sourceRoot":"","sources":["../../../src/settlement/contracts/DispatchSmartContract.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,EAIL,gBAAgB,EAChB,SAAS,EAET,aAAa,EACb,KAAK,EAGL,MAAM,EACP,MAAM,MAAM,CAAC;AACd,OAAO,EAA6B,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE1E,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AAQjE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AAGxE,OAAO,EACL,sBAAsB,EAGtB,uBAAuB,EAExB,MAAM,mBAAmB,CAAC;AAE3B,eAAO,MAAM,kBAAkB,mDAA6B,CAAC;AAE7D,MAAM,WAAW,oBAAoB;IACnC,kBAAkB,EAAE,CAClB,oBAAoB,EAAE,KAAK,EAC3B,uBAAuB,EAAE,KAAK,KAC3B,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,UAAU,EAAE,CAAC,kBAAkB,EAAE,SAAS,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7D,mBAAmB,EAAE,CACnB,OAAO,EAAE,KAAK,EACd,qBAAqB,EAAE,SAAS,EAChC,yBAAyB,EAAE,SAAS,KACjC,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnB,oBAAoB,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;CACpC;AAMD,8BAAsB,yBAA0B,SAAQ,aAAa;IACnE,OAAc,IAAI,EAAE;QAClB,gBAAgB,EAAE,sBAAsB,CAAC;QACzC,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC,CAAC;QAC7D,uBAAuB,CAAC,EAAE,UAAU,CAAC,sBAAsB,CAAC,GAC1D,OAAO,aAAa,CAAC;KACxB,CAAC;IAEF,MAAM;;;MAMJ;IAEF,QAAQ,CAAC,oBAAoB,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAE5C,QAAQ,CAAC,mBAAmB,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAE3C,QAAQ,CAAC,kBAAkB,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAE9C,QAAQ,CAAC,eAAe,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAEvC,QAAQ,CAAC,gBAAgB,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAExC,SAAS,CAAC,sBAAsB,CAC9B,oBAAoB,EAAE,KAAK,EAC3B,uBAAuB,EAAE,KAAK;IA+BhC,SAAS,CAAC,cAAc,CAAC,kBAAkB,EAAE,SAAS;IAYtD,SAAS,CAAC,eAAe,CAAC,IAAI,EAC5B,QAAQ,EAAE,KAAK,EACf,KAAK,EAAE,IAAI,EACX,SAAS,EAAE,gBAAgB,CAAC,IAAI,CAAC;cAmCnB,uBAAuB,CACrC,OAAO,EAAE,KAAK,EACd,qBAAqB,EAAE,SAAS,EAGhC,yBAAyB,EAAE,SAAS;CAsDvC;AAED,qBAAa,qBACX,SAAQ,yBACR,YAAW,oBAAoB;IAEV,oBAAoB,2DAAkB;IAEtC,mBAAmB,2DAAkB;IAEjC,kBAAkB,mBAAsB;IAE5C,eAAe,2DAAiC;IAEhD,gBAAgB,2DAAkB;IAG1C,mBAAmB,CAC9B,OAAO,EAAE,KAAK,EACd,qBAAqB,EAAE,SAAS,EAChC,yBAAyB,EAAE,SAAS;IAUzB,kBAAkB,CAC7B,oBAAoB,EAAE,KAAK,EAC3B,uBAAuB,EAAE,KAAK;IASnB,UAAU,CAAC,kBAAkB,EAAE,SAAS;IAKxC,OAAO,CAClB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,KAAK,EACd,gBAAgB,EAAE,SAAS,EAC3B,2BAA2B,EAAE,sBAAsB,EACnD,UAAU,EAAE,SAAS;CAgDxB"}

package/dist/settlement/contracts/DispatchSmartContract.js

@@ -0,0 +1,230 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { AccountUpdate, Bool, Field, method, Poseidon, Provable, PublicKey, Reducer, SmartContract, State, state, TokenId, UInt64, } from "o1js";
+import { InMemoryMerkleTreeStorage } from "@proto-kit/common";
+import { RuntimeTransaction } from "../../model/transaction/RuntimeTransaction";
+import { MinaActions, MinaEvents, } from "../../utils/MinaPrefixedProvableHashList";
+import { Deposit } from "../messages/Deposit";
+import { TokenBridgeDeploymentAuth } from "./authorizations/TokenBridgeDeploymentAuth";
+import { UpdateMessagesHashAuth } from "./authorizations/UpdateMessagesHashAuth";
+import { TokenBridgeAttestation, TokenBridgeEntry, TokenBridgeTree, TokenBridgeTreeAddition, TokenBridgeTreeWitness, } from "./TokenBridgeTree";
+export const ACTIONS_EMPTY_HASH = Reducer.initialActionState;
+const tokenBridgeRoot = new TokenBridgeTree(new InMemoryMerkleTreeStorage()).getRoot();
+export class DispatchSmartContractBase extends SmartContract {
+    constructor() {
+        super(...arguments);
+        this.events = {
+            "token-bridge-added": TokenBridgeTreeAddition,
+            // We need a placeholder event here, so that o1js internally adds a identifier to the
+            // emitted event-fields. That will lead to the o1js API being able to distinguish the
+            // TokenBridgeEvents from the manually emitted events for the incoming messages
+            "incoming-message-placeholder": Field,
+        };
+    }
+    updateMessagesHashBase(executedMessagesHash, newPromisedMessagesHash) {
+        const promisedMessagesHash = this.promisedMessagesHash.getAndRequireEquals();
+        this.honoredMessagesHash.getAndRequireEquals();
+        executedMessagesHash.assertEquals(promisedMessagesHash);
+        this.honoredMessagesHash.set(executedMessagesHash);
+        // Assert and apply new promisedMessagesHash
+        this.self.account.actionState.requireEquals(newPromisedMessagesHash);
+        this.promisedMessagesHash.set(newPromisedMessagesHash);
+        const settlementContractAddress = this.settlementContract.getAndRequireEquals();
+        const settlementContract = new DispatchSmartContractBase.args.settlementContractClass(settlementContractAddress);
+        settlementContract.authorizationField.requireEquals(new UpdateMessagesHashAuth({
+            target: this.address,
+            executedMessagesHash,
+            newPromisedMessagesHash,
+        }).hash());
+        this.approve(settlementContract.self);
+    }
+    initializeBase(settlementContract) {
+        this.promisedMessagesHash.getAndRequireEquals().assertEquals(Field(0));
+        this.honoredMessagesHash.getAndRequireEquals().assertEquals(Field(0));
+        this.settlementContract
+            .getAndRequireEquals()
+            .assertEquals(PublicKey.empty());
+        this.promisedMessagesHash.set(ACTIONS_EMPTY_HASH);
+        this.honoredMessagesHash.set(ACTIONS_EMPTY_HASH);
+        this.settlementContract.set(settlementContract);
+    }
+    dispatchMessage(methodId, value, valueType) {
+        const args = valueType.toFields(value);
+        // Should be the same as RuntimeTransaction.hash
+        const argsHash = Poseidon.hash(args);
+        const runtimeTransaction = RuntimeTransaction.fromMessage({
+            methodId,
+            argsHash,
+        });
+        // Append tx to incomingMessagesHash
+        const actionData = runtimeTransaction.hashData();
+        const actionHash = MinaActions.actionHash(actionData);
+        this.self.body.actions = {
+            hash: actionHash,
+            data: [actionData],
+        };
+        // Find event index of placeholder event that we can use for manual event dispatching
+        const eventIndex = Object.keys(this.events)
+            .sort()
+            .indexOf("incoming-message-placeholder");
+        if (eventIndex === -1) {
+            throw new Error("Unknown event type for placeholder event");
+        }
+        const paddedArgs = [Field(eventIndex), ...args];
+        const eventHash = MinaEvents.eventHash(paddedArgs);
+        this.self.body.events = {
+            hash: eventHash,
+            data: [paddedArgs],
+        };
+    }
+    async enableTokenDepositsBase(tokenId, bridgeContractAddress, 
+    // Witness it here, since o1js doesn't fetch this state correctly since
+    // its updated in a parent AU
+    settlementContractAddress
+    // treeWitness: TokenBridgeTreeWitness
+    ) {
+        this.settlementContract.requireEquals(settlementContractAddress);
+        const settlementContract = new DispatchSmartContractBase.args.settlementContractClass(settlementContractAddress);
+        // Append bridge address to the tree
+        // TODO This not concurrent and will fail if multiple users deploy bridges at the same time
+        const counter = this.tokenBridgeCount.getAndRequireEquals();
+        const root = this.tokenBridgeRoot.getAndRequireEquals();
+        const treeWitness = await Provable.witnessAsync(TokenBridgeTreeWitness, async () => {
+            const tree = await TokenBridgeTree.buildTreeFromEvents(this);
+            return tree.getWitness(counter.toBigInt());
+        });
+        Provable.log(root);
+        treeWitness
+            .checkMembership(root, counter, Field(0))
+            .assertTrue("Bridge Tree Witness not valid");
+        const entry = new TokenBridgeEntry({
+            tokenId,
+            address: bridgeContractAddress,
+        });
+        const newRoot = treeWitness.calculateRoot(entry.hash());
+        this.tokenBridgeRoot.set(newRoot);
+        this.tokenBridgeCount.set(counter.add(1));
+        this.emitEvent("token-bridge-added", new TokenBridgeTreeAddition({
+            index: counter,
+            value: entry,
+        }));
+        // Authenticate call via callback
+        settlementContract.authorizationField.requireEquals(new TokenBridgeDeploymentAuth({
+            target: this.address,
+            tokenId,
+            address: bridgeContractAddress,
+        }).hash());
+        this.approve(settlementContract.self);
+    }
+}
+export class DispatchSmartContract extends DispatchSmartContractBase {
+    constructor() {
+        super(...arguments);
+        this.promisedMessagesHash = State();
+        this.honoredMessagesHash = State();
+        this.settlementContract = State();
+        this.tokenBridgeRoot = State(tokenBridgeRoot);
+        this.tokenBridgeCount = State();
+    }
+    async enableTokenDeposits(tokenId, bridgeContractAddress, settlementContractAddress) {
+        await this.enableTokenDepositsBase(tokenId, bridgeContractAddress, settlementContractAddress);
+    }
+    async updateMessagesHash(executedMessagesHash, newPromisedMessagesHash) {
+        return this.updateMessagesHashBase(executedMessagesHash, newPromisedMessagesHash);
+    }
+    async initialize(settlementContract) {
+        return this.initializeBase(settlementContract);
+    }
+    async deposit(amount, tokenId, bridgingContract, bridgingContractAttestation, l2Receiver) {
+        const childrenMayUseToken = {
+            parentsOwnToken: Bool(false),
+            // MayUseToken has to be set only for custom tokens
+            inheritFromParent: tokenId.equals(TokenId.default).not(),
+        };
+        // Check that the bridgingContract parameter is valid => is in the offchain tree
+        const bridgeTreeRoot = this.tokenBridgeRoot.getAndRequireEquals();
+        const entry = new TokenBridgeEntry({
+            tokenId,
+            address: bridgingContract,
+        });
+        bridgingContractAttestation.witness
+            .checkMembership(bridgeTreeRoot, bridgingContractAttestation.index, entry.hash())
+            .assertTrue("Bridging Contract Attestation not valid");
+        // Credit the amount to the settlement contract
+        const balanceAU = AccountUpdate.create(bridgingContract, tokenId);
+        balanceAU.balance.addInPlace(amount);
+        balanceAU.body.mayUseToken = childrenMayUseToken;
+        this.approve(balanceAU);
+        const action = new Deposit({
+            tokenId,
+            address: l2Receiver,
+            amount,
+        });
+        const { methodIdMappings, incomingMessagesPaths } = DispatchSmartContractBase.args;
+        const methodId = Field(methodIdMappings[incomingMessagesPaths.deposit].methodId).toConstant();
+        this.dispatchMessage(methodId.toConstant(), action, Deposit);
+        this.self.body.mayUseToken = {
+            parentsOwnToken: tokenId.equals(TokenId.default).not(),
+            inheritFromParent: Bool(false),
+        };
+    }
+}
+__decorate([
+    state(Field),
+    __metadata("design:type", Object)
+], DispatchSmartContract.prototype, "promisedMessagesHash", void 0);
+__decorate([
+    state(Field),
+    __metadata("design:type", Object)
+], DispatchSmartContract.prototype, "honoredMessagesHash", void 0);
+__decorate([
+    state(PublicKey),
+    __metadata("design:type", Object)
+], DispatchSmartContract.prototype, "settlementContract", void 0);
+__decorate([
+    state(Field),
+    __metadata("design:type", Object)
+], DispatchSmartContract.prototype, "tokenBridgeRoot", void 0);
+__decorate([
+    state(Field),
+    __metadata("design:type", Object)
+], DispatchSmartContract.prototype, "tokenBridgeCount", void 0);
+__decorate([
+    method,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Field,
+        PublicKey,
+        PublicKey]),
+    __metadata("design:returntype", Promise)
+], DispatchSmartContract.prototype, "enableTokenDeposits", null);
+__decorate([
+    method,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Field,
+        Field]),
+    __metadata("design:returntype", Promise)
+], DispatchSmartContract.prototype, "updateMessagesHash", null);
+__decorate([
+    method,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [PublicKey]),
+    __metadata("design:returntype", Promise)
+], DispatchSmartContract.prototype, "initialize", null);
+__decorate([
+    method,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [UInt64,
+        Field,
+        PublicKey,
+        TokenBridgeAttestation,
+        PublicKey]),
+    __metadata("design:returntype", Promise)
+], DispatchSmartContract.prototype, "deposit", null);
+//# sourceMappingURL=DispatchSmartContract.js.map

package/dist/settlement/contracts/DispatchSmartContract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DispatchSmartContract.js","sourceRoot":"","sources":["../../../src/settlement/contracts/DispatchSmartContract.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EACL,aAAa,EACb,IAAI,EACJ,KAAK,EACL,MAAM,EACN,QAAQ,EACR,QAAQ,EAER,SAAS,EACT,OAAO,EACP,aAAa,EACb,KAAK,EACL,KAAK,EACL,OAAO,EACP,MAAM,GACP,MAAM,MAAM,CAAC;AACd,OAAO,EAAE,yBAAyB,EAAc,MAAM,mBAAmB,CAAC;AAG1E,OAAO,EAAE,kBAAkB,EAAE,MAAM,4CAA4C,CAAC;AAChF,OAAO,EACL,WAAW,EACX,UAAU,GACX,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAG9C,OAAO,EAAE,yBAAyB,EAAE,MAAM,4CAA4C,CAAC;AACvF,OAAO,EAAE,sBAAsB,EAAE,MAAM,yCAAyC,CAAC;AACjF,OAAO,EACL,sBAAsB,EACtB,gBAAgB,EAChB,eAAe,EACf,uBAAuB,EACvB,sBAAsB,GACvB,MAAM,mBAAmB,CAAC;AAE3B,MAAM,CAAC,MAAM,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;AAiB7D,MAAM,eAAe,GAAG,IAAI,eAAe,CACzC,IAAI,yBAAyB,EAAE,CAChC,CAAC,OAAO,EAAE,CAAC;AAEZ,MAAM,OAAgB,yBAA0B,SAAQ,aAAa;IAArE;;QAQE,WAAM,GAAG;YACP,oBAAoB,EAAE,uBAAuB;YAC7C,qFAAqF;YACrF,qFAAqF;YACrF,+EAA+E;YAC/E,8BAA8B,EAAE,KAAK;SACtC,CAAC;IA0JJ,CAAC;IA9IW,sBAAsB,CAC9B,oBAA2B,EAC3B,uBAA8B;QAE9B,MAAM,oBAAoB,GACxB,IAAI,CAAC,oBAAoB,CAAC,mBAAmB,EAAE,CAAC;QAClD,IAAI,CAAC,mBAAmB,CAAC,mBAAmB,EAAE,CAAC;QAE/C,oBAAoB,CAAC,YAAY,CAAC,oBAAoB,CAAC,CAAC;QAExD,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;QAEnD,4CAA4C;QAC5C,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;QACrE,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;QAEvD,MAAM,yBAAyB,GAC7B,IAAI,CAAC,kBAAkB,CAAC,mBAAmB,EAAE,CAAC;QAChD,MAAM,kBAAkB,GACtB,IAAI,yBAAyB,CAAC,IAAI,CAAC,uBAAwB,CACzD,yBAAyB,CAC1B,CAAC;QAEJ,kBAAkB,CAAC,kBAAkB,CAAC,aAAa,CACjD,IAAI,sBAAsB,CAAC;YACzB,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,oBAAoB;YACpB,uBAAuB;SACxB,CAAC,CAAC,IAAI,EAAE,CACV,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IAES,cAAc,CAAC,kBAA6B;QACpD,IAAI,CAAC,oBAAoB,CAAC,mBAAmB,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACvE,IAAI,CAAC,mBAAmB,CAAC,mBAAmB,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACtE,IAAI,CAAC,kBAAkB;aACpB,mBAAmB,EAAE;aACrB,YAAY,CAAC,SAAS,CAAC,KAAK,EAAoB,CAAC,CAAC;QAErD,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;QAClD,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;QACjD,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IAClD,CAAC;IAES,eAAe,CACvB,QAAe,EACf,KAAW,EACX,SAAiC;QAEjC,MAAM,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACvC,gDAAgD;QAChD,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,WAAW,CAAC;YACxD,QAAQ;YACR,QAAQ;SACT,CAAC,CAAC;QAEH,oCAAoC;QACpC,MAAM,UAAU,GAAG,kBAAkB,CAAC,QAAQ,EAAE,CAAC;QACjD,MAAM,UAAU,GAAG,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAEtD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG;YACvB,IAAI,EAAE,UAAU;YAChB,IAAI,EAAE,CAAC,UAAU,CAAC;SACnB,CAAC;QAEF,qFAAqF;QACrF,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;aACxC,IAAI,EAAE;aACN,OAAO,CAAC,8BAA8B,CAAC,CAAC;QAC3C,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;SAC7D;QACD,MAAM,UAAU,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;QAEhD,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACnD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG;YACtB,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,CAAC,UAAU,CAAC;SACnB,CAAC;IACJ,CAAC;IAES,KAAK,CAAC,uBAAuB,CACrC,OAAc,EACd,qBAAgC;IAChC,uEAAuE;IACvE,6BAA6B;IAC7B,yBAAoC;IACpC,sCAAsC;;QAEtC,IAAI,CAAC,kBAAkB,CAAC,aAAa,CAAC,yBAAyB,CAAC,CAAC;QACjE,MAAM,kBAAkB,GACtB,IAAI,yBAAyB,CAAC,IAAI,CAAC,uBAAwB,CACzD,yBAAyB,CAC1B,CAAC;QAEJ,oCAAoC;QACpC,2FAA2F;QAC3F,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,mBAAmB,EAAE,CAAC;QAC5D,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,mBAAmB,EAAE,CAAC;QAExD,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,YAAY,CAC7C,sBAAsB,EACtB,KAAK,IAAI,EAAE;YACT,MAAM,IAAI,GAAG,MAAM,eAAe,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;YAC7D,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC7C,CAAC,CACF,CAAC;QAEF,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACnB,WAAW;aACR,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;aACxC,UAAU,CAAC,+BAA+B,CAAC,CAAC;QAE/C,MAAM,KAAK,GAAG,IAAI,gBAAgB,CAAC;YACjC,OAAO;YACP,OAAO,EAAE,qBAAqB;SAC/B,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;QACxD,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAClC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAE1C,IAAI,CAAC,SAAS,CACZ,oBAAoB,EACpB,IAAI,uBAAuB,CAAC;YAC1B,KAAK,EAAE,OAAO;YACd,KAAK,EAAE,KAAK;SACb,CAAC,CACH,CAAC;QAEF,iCAAiC;QACjC,kBAAkB,CAAC,kBAAkB,CAAC,aAAa,CACjD,IAAI,yBAAyB,CAAC;YAC5B,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,OAAO;YACP,OAAO,EAAE,qBAAqB;SAC/B,CAAC,CAAC,IAAI,EAAE,CACV,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;CACF;AAED,MAAM,OAAO,qBACX,SAAQ,yBAAyB;IADnC;;QAIuB,yBAAoB,GAAG,KAAK,EAAS,CAAC;QAEtC,wBAAmB,GAAG,KAAK,EAAS,CAAC;QAEjC,uBAAkB,GAAG,KAAK,EAAa,CAAC;QAE5C,oBAAe,GAAG,KAAK,CAAQ,eAAe,CAAC,CAAC;QAEhD,qBAAgB,GAAG,KAAK,EAAS,CAAC;IAqFzD,CAAC;IAlFc,AAAN,KAAK,CAAC,mBAAmB,CAC9B,OAAc,EACd,qBAAgC,EAChC,yBAAoC;QAEpC,MAAM,IAAI,CAAC,uBAAuB,CAChC,OAAO,EACP,qBAAqB,EACrB,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAGY,AAAN,KAAK,CAAC,kBAAkB,CAC7B,oBAA2B,EAC3B,uBAA8B;QAE9B,OAAO,IAAI,CAAC,sBAAsB,CAChC,oBAAoB,EACpB,uBAAuB,CACxB,CAAC;IACJ,CAAC;IAGY,AAAN,KAAK,CAAC,UAAU,CAAC,kBAA6B;QACnD,OAAO,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;IACjD,CAAC;IAGY,AAAN,KAAK,CAAC,OAAO,CAClB,MAAc,EACd,OAAc,EACd,gBAA2B,EAC3B,2BAAmD,EACnD,UAAqB;QAErB,MAAM,mBAAmB,GAAyC;YAChE,eAAe,EAAE,IAAI,CAAC,KAAK,CAAC;YAC5B,mDAAmD;YACnD,iBAAiB,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE;SACzD,CAAC;QAEF,gFAAgF;QAChF,MAAM,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC,mBAAmB,EAAE,CAAC;QAClE,MAAM,KAAK,GAAG,IAAI,gBAAgB,CAAC;YACjC,OAAO;YACP,OAAO,EAAE,gBAAgB;SAC1B,CAAC,CAAC;QAEH,2BAA2B,CAAC,OAAO;aAChC,eAAe,CACd,cAAc,EACd,2BAA2B,CAAC,KAAK,EACjC,KAAK,CAAC,IAAI,EAAE,CACb;aACA,UAAU,CAAC,yCAAyC,CAAC,CAAC;QAEzD,+CAA+C;QAC/C,MAAM,SAAS,GAAG,aAAa,CAAC,MAAM,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;QAClE,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACrC,SAAS,CAAC,IAAI,CAAC,WAAW,GAAG,mBAAmB,CAAC;QACjD,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAExB,MAAM,MAAM,GAAG,IAAI,OAAO,CAAC;YACzB,OAAO;YACP,OAAO,EAAE,UAAU;YACnB,MAAM;SACP,CAAC,CAAC;QAEH,MAAM,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,GAC/C,yBAAyB,CAAC,IAAI,CAAC;QAEjC,MAAM,QAAQ,GAAG,KAAK,CACpB,gBAAgB,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,QAAQ,CACzD,CAAC,UAAU,EAAE,CAAC;QACf,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAE7D,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG;YAC3B,eAAe,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE;YACtD,iBAAiB,EAAE,IAAI,CAAC,KAAK,CAAC;SAC/B,CAAC;IACJ,CAAC;CACF;AA7FsB;IAApB,KAAK,CAAC,KAAK,CAAC;;mEAA8C;AAEtC;IAApB,KAAK,CAAC,KAAK,CAAC;;kEAA6C;AAEjC;IAAxB,KAAK,CAAC,SAAS,CAAC;;iEAAgD;AAE5C;IAApB,KAAK,CAAC,KAAK,CAAC;;8DAAwD;AAEhD;IAApB,KAAK,CAAC,KAAK,CAAC;;+DAA0C;AAG1C;IADZ,MAAM;;qCAEI,KAAK;QACS,SAAS;QACL,SAAS;;gEAOrC;AAGY;IADZ,MAAM;;qCAEiB,KAAK;QACF,KAAK;;+DAM/B;AAGY;IADZ,MAAM;;qCACqC,SAAS;;uDAEpD;AAGY;IADZ,MAAM;;qCAEG,MAAM;QACL,KAAK;QACI,SAAS;QACE,sBAAsB;QACvC,SAAS;;oDA+CtB"}

package/dist/settlement/contracts/SettlementContractProtocolModule.d.ts

@@ -0,0 +1,21 @@
+import { ArtifactRecord, ChildVerificationKeyService, CompileRegistry } from "@proto-kit/common";
+import { BlockProvable } from "../../prover/block/BlockProvable";
+import { ContractModule, SmartContractClassFromInterface } from "../ContractModule";
+import { ProvableSettlementHook } from "../modularity/ProvableSettlementHook";
+import { SettlementContractType } from "./SettlementSmartContract";
+import { DispatchContractProtocolModule } from "./DispatchContractProtocolModule";
+import { BridgeContractProtocolModule } from "./BridgeContractProtocolModule";
+export type SettlementContractConfig = {
+    escapeHatchSlotsInterval?: number;
+};
+export declare class SettlementContractProtocolModule extends ContractModule<SettlementContractType, SettlementContractConfig> {
+    private readonly hooks;
+    private readonly blockProver;
+    private readonly dispatchContractModule;
+    private readonly bridgeContractModule;
+    private readonly childVerificationKeyService;
+    constructor(hooks: ProvableSettlementHook<unknown>[], blockProver: BlockProvable, dispatchContractModule: DispatchContractProtocolModule, bridgeContractModule: BridgeContractProtocolModule, childVerificationKeyService: ChildVerificationKeyService);
+    contractFactory(): SmartContractClassFromInterface<SettlementContractType>;
+    compile(registry: CompileRegistry): Promise<ArtifactRecord | undefined>;
+}
+//# sourceMappingURL=SettlementContractProtocolModule.d.ts.map