Withdrawals refactor

l1/src/contracts/bridge.ts

@@ -98,9 +98,9 @@ export class Bridge extends SmartContract {
   /**
    * Finalize the L1 deposit.
    * used when the aggregations are done, and the satoshis of the aggregator utxo should be merged into the bridge utxo.
-   * 
+   *
    * tx: bridgeInput + aggregatorInput + feeInput => stateOutput + bridgeOutput + changeOutput(optional)
-   * 
+   *
    * @param shPreimage - The sighash preimage.
    * @param sigOperator - The operator signature.
    * @param prevTx - The previous bridge transaction.
@@ -188,9 +188,9 @@ export class Bridge extends SmartContract {
   /**
    * Finalize the L2 deposit.
    * used when the operator has sent the bitocin to the deposit addresses on l2 for a deposit batch. So the operator notify the bridge contract on L1 that the deposit batch is done.
-   * 
+   *
    * tx: bridgeInput + feeInput => stateOutput + bridgeOutput + changeOutput(optional)
-   * 
+   *
    * @param shPreimage - The sighash preimage.
    * @param sigOperator - The operator signature.
    * @param prevTx - The previous bridge transaction.
@@ -261,13 +261,13 @@ export class Bridge extends SmartContract {
 
   /**
    * Create a withdrawal transaction.
-   * 
+   *
    * Used when the users want to withdraw from L2 to L1.
    * The users request their withdrawals on L2, the operator collects the withdrawals.
    * Then call this function to create a withdrawalExpander utxo on L1 to start the L1 withdrawal process.
-   * 
+   *
    * tx: bridgeInput + feeInput => stateOutput + bridgeOutput + expanderOutput + changeOutput(optional)
-   * 
+   *
    * @param shPreimage - The sighash preimage.
    * @param sigOperator - The operator signature.
    * @param prevTx - The previous bridge transaction.
@@ -336,19 +336,19 @@ export class Bridge extends SmartContract {
 
   /**
    * Get the txid of the bridge transaction.
-   * 
-   * deployBridgeContract tx: 
+   *
+   * deployBridgeContract tx:
    * feeInput => stateOutput + bridgeOutput + changeOutput(optional)
-   * 
-   * finalizeL1Deposit  tx: 
+   *
+   * finalizeL1Deposit  tx:
    * bridgeInput + depositAggregatorInput + feeInput => stateOutput + bridgeOutput + changeOutput(optional)
-   * 
-   * finalizeL2Deposit tx: 
+   *
+   * finalizeL2Deposit tx:
    * bridgeInput + feeInput => stateOutput + bridgeOutput + changeOutput(optional)
-   * 
-   * createWithdrawal tx: 
+   *
+   * createWithdrawal tx:
    * bridgeInput + feeInput => stateOutput + bridgeOutput + expanderOutput + changeOutput(optional)
-   * 
+   *
    * @param tx - The bridge transaction.
    * @param expanderSPK - The script pubkey of the expander contract output.
    * @returns The txid of the bridge transaction.
@@ -392,7 +392,7 @@ export class Bridge extends SmartContract {
 
   /**
    * Get the hash of the finalizeL1Deposit transaction prevouts.
-   * 
+   *
    * @param prevTxId - The previous transaction id.
    * @param aggregatorTxId - The aggregator transaction id.
    * @param feePrevout - The fee prevout.
@@ -415,7 +415,7 @@ export class Bridge extends SmartContract {
 
   /**
    * Get the hash of the non-finalizeL1Deposit transaction prevouts.
-   * 
+   *
    * @param prevTxId - The previous transaction id.
    * @param feePrevout - The fee prevout.
    * @returns The hash of the non-finalizeL1Deposit transaction prevouts.

l1/src/contracts/depositAggregator.ts

@@ -60,9 +60,9 @@ export class DepositAggregator extends SmartContract {
 
   /**
    * Aggregates two aggregator utxos into one.
-   * 
+   *
    * tx: aggregatorInput0 + aggregatorInput1 + feeInput => stateOutput + aggregatorOutput + changeOutput(optional)
-   * 
+   *
    * @param shPreimage - The sighash preimage of the currently executing transaction.
    * @param sigOperator - The signature of the bridge operator.
    * @param level - The level of the aggregation; zero is the first level, which is the leaf level
@@ -74,7 +74,8 @@ export class DepositAggregator extends SmartContract {
    * @param ancestorTx3 - The previous transaction of second input of prevTx1
    * @param feePrevout - The prevout of the fee input
    * @param isFirstInput - Indicates whether this method is called from the first or second input.
-   * 
+   * @param depositData0 - Actual deposit data of the first deposit; used when aggregating leaves.
+   * @param depositData1 - Actual deposit data of the second deposit; used when aggregating leaves.
    */
   @method()
   public aggregate(
@@ -292,7 +293,7 @@ export class DepositAggregator extends SmartContract {
   }
 
   /**
-   * Hash the deposit data. 
+   * Hash the deposit data.
    * For depositData, we store the plain data, not hashed.
    * @param depositAddress - The L2 address of the deposit.
    * @param depositAmt - The amount of the deposit.

l1/src/contracts/generalUtils.ts

@@ -78,9 +78,9 @@ export class GeneralUtils extends SmartContractLib {
   }
 
   /**
-   * Get the contract output. 
+   * Get the contract output.
    * output=satoshis[8 bytes] + spkLength[1 byte] + spk[34 bytes]
-   * 
+   *
    * @param amt - The amount of the output.
    * @param spk - The script pubkey of the output.
    * @returns The contract output.

l1/src/contracts/sigHashUtils.ts

@@ -67,7 +67,7 @@ export type SHPreimage = {
    */
   hashTapLeaf: ByteString
   /**
-   * (1): the key version. 
+   * (1): the key version.
    * a constant value 0x00 representing the current version of public keys in the tapscript signature opcode execution.
    * ref: https://github.com/bitcoin/bips/blob/master/bip-0342.mediawiki#common-signature-message-extension
    */
@@ -140,6 +140,7 @@ export class SigHashUtils extends SmartContractLib {
     assert(e == shPreimage._e + eLastByte, 'invalid value of _e')
     const s =
       SigHashUtils.Gx + shPreimage._e + int2ByteString(shPreimage.eSuffix + 1n)
+    //assert(this.checkSig(Sig(s), SigHashUtils.Gx)) TODO (currently done outside)
     return Sig(s)
   }
 }

l1/src/covenants/depositAggregatorCovenant.ts

@@ -345,6 +345,8 @@ export class DepositAggregatorCovenant extends Covenant<DepositAggregatorState>
   ): Promise<TracedDepositAggregator> {
     const level = utxo.state.level;
 
+    console.log("level", level);
+
     const covenant = new DepositAggregatorCovenant(
       utxo.operator,
       utxo.bridgeSPK,

l1/src/features/bridge.ts

@@ -366,6 +366,101 @@ export async function createWithdrawalExpander(
   }
 }
 
+export async function createWithdrawalExpander2(
+  signer: Signer,
+  network: SupportedNetwork,
+  utxoProvider: UtxoProvider,
+  chainProvider: ChainProvider,
+  bridgeUtxo: TraceableBridgeUtxo,
+
+  withdrawalMerkleRoot: Sha256,
+  outputWithdrawalState: WithdrawalExpanderState,
+
+  feeRate: number
+) {
+  const changeAddress = await signer.getAddress()
+
+  // TODO: Does this check makes any sense?
+  // withdrawals.forEach((withdrawal) =>
+  //   WithdrawalMerkle.checkWithdrawalValid(withdrawal)
+  // )
+
+  const sumAmt = outputWithdrawalState.type === 'LEAF' ?
+    outputWithdrawalState.withdrawAmt :
+    outputWithdrawalState.leftAmt +  outputWithdrawalState.rightAmt;
+
+  console.log("sumAmt > bridgeUtxo.utxo.satoshis", sumAmt, bridgeUtxo.utxo.satoshis)
+
+  if (sumAmt > bridgeUtxo.utxo.satoshis) {
+    throw new Error('withdrawal amt is greater than bridge utxo satoshis')
+  }
+
+  const tracedBridge = await BridgeCovenant.backtrace(bridgeUtxo, chainProvider)
+  const outputBridgeCovenant = new BridgeCovenant(
+    tracedBridge.covenant.operator,
+    tracedBridge.covenant.expanderSPK,
+    tracedBridge.covenant.state
+  )
+
+  const outputWithdrawalExpanderCovenant = new WithdrawalExpanderCovenant(
+    tracedBridge.covenant.operator,
+    outputWithdrawalState
+  )
+
+  const est = estimateCreateWithdrawalTxVSize(
+    network,
+    bridgeUtxo,
+    tracedBridge,
+    outputBridgeCovenant,
+    outputWithdrawalExpanderCovenant,
+    withdrawalMerkleRoot,
+    sumAmt,
+    changeAddress,
+    feeRate
+  )
+  const total = feeRate * est.vSize
+  const utxos = await utxoProvider.getUtxos(changeAddress, {
+    total: Number(total),
+  })
+  if (utxos.length === 0) {
+    throw new Error(`Insufficient satoshis input amount: no utxos found`)
+  }
+  const feeUtxo = pickLargeFeeUtxo(utxos)
+  if (feeUtxo.satoshis < total) {
+    throw new Error(
+      `Insufficient satoshis input amount: fee utxo(${feeUtxo.satoshis}) < total(${total})`
+    )
+  }
+
+  const createWithdrawalTx = buildCreateWithdrawalTx(
+    network,
+    feeUtxo,
+    bridgeUtxo,
+    tracedBridge,
+    outputBridgeCovenant,
+    outputWithdrawalExpanderCovenant,
+    withdrawalMerkleRoot,
+    sumAmt,
+    changeAddress,
+    feeRate
+  )
+
+  const signedPsbt = await signer.signPsbt(createWithdrawalTx.toHex(), createWithdrawalTx.psbtOptions())
+  const txPsbt = createWithdrawalTx.combine(ExtPsbt.fromHex(signedPsbt))
+  await txPsbt.finalizeAllInputsAsync()
+  const tx = txPsbt.extractTransaction()
+  await chainProvider.broadcast(tx.toHex())
+  markSpent(utxoProvider, tx)
+  return {
+    psbt: txPsbt,
+    txid: tx.getId(),
+    bridgeState: outputBridgeCovenant.state,
+    withdrawalState: outputWithdrawalExpanderCovenant.state,
+    bridgeUtxo: outputToUtxo(tx, CONTRACT_INDEXES.outputIndex.bridge) as UTXO,
+    withdrawalUtxo: outputToUtxo(tx, CONTRACT_INDEXES.outputIndex.withdrawalExpander.inBridgeTx) as UTXO,
+  }
+}
+
 function estimateCreateWithdrawalTxVSize(
   network: SupportedNetwork,
   bridgeUtxo: TraceableBridgeUtxo,