@proto-kit/protocol 0.1.1-develop.0

package/src/settlement/contracts/BridgeContract.ts

@@ -0,0 +1,237 @@
+import {
+  AccountUpdate,
+  Bool,
+  Field,
+  method,
+  Permissions,
+  Poseidon,
+  Provable,
+  PublicKey,
+  SmartContract,
+  State,
+  state,
+  Struct,
+  TokenContractV2,
+  TokenId,
+  VerificationKey,
+} from "o1js";
+import { noop, range, TypedClass } from "@proto-kit/common";
+
+import {
+  OUTGOING_MESSAGE_BATCH_SIZE,
+  OutgoingMessageArgumentBatch,
+} from "../messages/OutgoingMessageArgument";
+import { Path } from "../../model/Path";
+import { Withdrawal } from "../messages/Withdrawal";
+
+import type { SettlementContractType } from "./SettlementSmartContract";
+
+export type BridgeContractType = {
+  stateRoot: State<Field>;
+  outgoingMessageCursor: State<Field>;
+
+  rollupOutgoingMessages: (
+    batch: OutgoingMessageArgumentBatch
+  ) => Promise<Field>;
+  redeem: (additionUpdate: AccountUpdate) => Promise<void>;
+
+  deployProvable: (
+    args: VerificationKey | undefined,
+    signedSettlement: boolean,
+    permissions: Permissions,
+    settlementContractAddress: PublicKey
+  ) => Promise<AccountUpdate>;
+
+  updateStateRoot: (root: Field) => Promise<void>;
+};
+
+// Equal to WithdrawalKey
+export class OutgoingMessageKey extends Struct({
+  index: Field,
+  tokenId: Field,
+}) {}
+
+export abstract class BridgeContractBase extends TokenContractV2 {
+  public static args: {
+    SettlementContract:
+      | (TypedClass<SettlementContractType> & typeof SmartContract)
+      | undefined;
+    withdrawalStatePath: [string, string];
+  };
+
+  abstract settlementContractAddress: State<PublicKey>;
+
+  abstract stateRoot: State<Field>;
+
+  abstract outgoingMessageCursor: State<Field>;
+
+  /**
+   * 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
+   */
+  public async deployProvable(
+    verificationKey: VerificationKey | undefined,
+    signedSettlement: boolean,
+    permissions: Permissions,
+    settlementContractAddress: PublicKey
+  ) {
+    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;
+  }
+
+  public async approveBase(): Promise<void> {
+    noop();
+  }
+
+  public async updateStateRootBase(root: Field) {
+    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);
+  }
+
+  public async rollupOutgoingMessagesBase(
+    batch: OutgoingMessageArgumentBatch
+  ): Promise<Field> {
+    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;
+  }
+
+  protected async redeemBase(additionUpdate: AccountUpdate) {
+    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
+  implements BridgeContractType
+{
+  @state(PublicKey) public settlementContractAddress = State<PublicKey>();
+
+  @state(Field) public stateRoot = State<Field>();
+
+  @state(Field) public outgoingMessageCursor = State<Field>();
+
+  @method
+  public async updateStateRoot(root: Field) {
+    return await this.updateStateRootBase(root);
+  }
+
+  @method.returns(Field)
+  public async rollupOutgoingMessages(
+    batch: OutgoingMessageArgumentBatch
+  ): Promise<Field> {
+    return await this.rollupOutgoingMessagesBase(batch);
+  }
+
+  @method
+  public async redeem(additionUpdate: AccountUpdate) {
+    return await this.redeemBase(additionUpdate);
+  }
+}

package/src/settlement/contracts/BridgeContractProtocolModule.ts

@@ -0,0 +1,43 @@
+import { injectable } from "tsyringe";
+import { CompileRegistry } from "@proto-kit/common";
+
+import { ContractModule } from "../ContractModule";
+
+import {
+  BridgeContract,
+  BridgeContractBase,
+  BridgeContractType,
+} from "./BridgeContract";
+
+export type BridgeContractConfig = {
+  withdrawalStatePath: `${string}.${string}`;
+  withdrawalEventName: string;
+};
+
+@injectable()
+export class BridgeContractProtocolModule extends ContractModule<
+  BridgeContractType,
+  BridgeContractConfig
+> {
+  public contractFactory() {
+    const { config } = this;
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+    const withdrawalStatePathSplit = config.withdrawalStatePath.split(".") as [
+      string,
+      string,
+    ];
+
+    BridgeContractBase.args = {
+      withdrawalStatePath: withdrawalStatePathSplit,
+      SettlementContract: BridgeContractBase.args?.SettlementContract,
+    };
+
+    return BridgeContract;
+  }
+
+  public async compile(registry: CompileRegistry) {
+    return {
+      BridgeContract: await registry.compile(BridgeContract),
+    };
+  }
+}

package/src/settlement/contracts/DispatchContractProtocolModule.ts

@@ -0,0 +1,73 @@
+import { inject, injectable } from "tsyringe";
+import { PublicKey } from "o1js";
+import { CompileRegistry } from "@proto-kit/common";
+
+import { RuntimeLike, RuntimeMethodIdMapping } from "../../model/RuntimeLike";
+import {
+  ContractModule,
+  SmartContractClassFromInterface,
+} from "../ContractModule";
+
+import {
+  DispatchSmartContract,
+  DispatchContractType,
+  DispatchSmartContractBase,
+} from "./DispatchSmartContract";
+
+export type DispatchContractConfig = {
+  incomingMessagesMethods: Record<string, `${string}.${string}`>;
+};
+
+@injectable()
+export class DispatchContractProtocolModule extends ContractModule<
+  DispatchContractType,
+  DispatchContractConfig
+> {
+  public constructor(@inject("Runtime") private readonly runtime: RuntimeLike) {
+    super();
+  }
+
+  public eventsDefinition() {
+    return new DispatchSmartContract(PublicKey.empty<typeof PublicKey>())
+      .events;
+  }
+
+  private checkConfigIntegrity(
+    incomingMessagesMethods: Record<string, `${string}.${string}`>,
+    runtimeMethodIds: RuntimeMethodIdMapping
+  ) {
+    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}]`
+      );
+    }
+  }
+
+  public contractFactory(): SmartContractClassFromInterface<DispatchContractType> {
+    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;
+  }
+
+  public async compile(registry: CompileRegistry) {
+    if (DispatchSmartContractBase.args.settlementContractClass === undefined) {
+      throw new Error("Reference to Settlement Contract not set");
+    }
+    return {
+      DispatchSmartContract: await registry.compile(DispatchSmartContract),
+    };
+  }
+}

package/src/settlement/contracts/DispatchSmartContract.ts

@@ -0,0 +1,326 @@
+import {
+  AccountUpdate,
+  Bool,
+  Field,
+  method,
+  Poseidon,
+  Provable,
+  ProvableExtended,
+  PublicKey,
+  Reducer,
+  SmartContract,
+  State,
+  state,
+  TokenId,
+  UInt64,
+} from "o1js";
+import { InMemoryMerkleTreeStorage, TypedClass } from "@proto-kit/common";
+
+import { RuntimeMethodIdMapping } from "../../model/RuntimeLike";
+import { RuntimeTransaction } from "../../model/transaction/RuntimeTransaction";
+import {
+  MinaActions,
+  MinaEvents,
+} from "../../utils/MinaPrefixedProvableHashList";
+import { Deposit } from "../messages/Deposit";
+
+import type { SettlementContractType } from "./SettlementSmartContract";
+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;
+
+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>;
+}
+
+const tokenBridgeRoot = new TokenBridgeTree(
+  new InMemoryMerkleTreeStorage()
+).getRoot();
+
+export abstract class DispatchSmartContractBase extends SmartContract {
+  public static args: {
+    methodIdMappings: RuntimeMethodIdMapping;
+    incomingMessagesPaths: Record<string, `${string}.${string}`>;
+    settlementContractClass?: TypedClass<SettlementContractType> &
+      typeof SmartContract;
+  };
+
+  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,
+  };
+
+  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
+  ) {
+    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);
+  }
+
+  protected initializeBase(settlementContract: PublicKey) {
+    this.promisedMessagesHash.getAndRequireEquals().assertEquals(Field(0));
+    this.honoredMessagesHash.getAndRequireEquals().assertEquals(Field(0));
+    this.settlementContract
+      .getAndRequireEquals()
+      .assertEquals(PublicKey.empty<typeof PublicKey>());
+
+    this.promisedMessagesHash.set(ACTIONS_EMPTY_HASH);
+    this.honoredMessagesHash.set(ACTIONS_EMPTY_HASH);
+    this.settlementContract.set(settlementContract);
+  }
+
+  protected dispatchMessage<Type>(
+    methodId: Field,
+    value: Type,
+    valueType: ProvableExtended<Type>
+  ) {
+    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],
+    };
+  }
+
+  protected async enableTokenDepositsBase(
+    tokenId: Field,
+    bridgeContractAddress: PublicKey,
+    // Witness it here, since o1js doesn't fetch this state correctly since
+    // its updated in a parent AU
+    settlementContractAddress: PublicKey
+    // 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
+  implements DispatchContractType
+{
+  @state(Field) public promisedMessagesHash = State<Field>();
+
+  @state(Field) public honoredMessagesHash = State<Field>();
+
+  @state(PublicKey) public settlementContract = State<PublicKey>();
+
+  @state(Field) public tokenBridgeRoot = State<Field>(tokenBridgeRoot);
+
+  @state(Field) public tokenBridgeCount = State<Field>();
+
+  @method
+  public async enableTokenDeposits(
+    tokenId: Field,
+    bridgeContractAddress: PublicKey,
+    settlementContractAddress: PublicKey
+  ) {
+    await this.enableTokenDepositsBase(
+      tokenId,
+      bridgeContractAddress,
+      settlementContractAddress
+    );
+  }
+
+  @method
+  public async updateMessagesHash(
+    executedMessagesHash: Field,
+    newPromisedMessagesHash: Field
+  ) {
+    return this.updateMessagesHashBase(
+      executedMessagesHash,
+      newPromisedMessagesHash
+    );
+  }
+
+  @method
+  public async initialize(settlementContract: PublicKey) {
+    return this.initializeBase(settlementContract);
+  }
+
+  @method
+  public async deposit(
+    amount: UInt64,
+    tokenId: Field,
+    bridgingContract: PublicKey,
+    bridgingContractAttestation: TokenBridgeAttestation,
+    l2Receiver: PublicKey
+  ) {
+    const childrenMayUseToken: AccountUpdate["body"]["mayUseToken"] = {
+      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),
+    };
+  }
+}