CORE-1952 add v2 complete withdrawal

CHANGELOG.md

@@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.7.0] - 2024-02-26
+
+### Added
+
+- `completeWithdrawal` has been updated to use V2 withdrawal logic for StarkEx V4 contract.
+
+## [2.6.0] - 2024-02-26
+
+### Added
+
+- `prepareWithdrawal` has been updated to use V2 withdrawal logic for StarkEx V4 contract.
+- Add StarkEx V4 contract bindings so that SDK can interact with the contract.
+
 ## [2.5.4] - 2024-02-20
 
 ### Added

examples/completeErc20Withdrawal.ts

@@ -7,11 +7,8 @@ import { generateWalletConnection } from './libs/walletConnection';
 
     const client = new ImmutableX(Config.SANDBOX);
 
-    const starkPublicKey = await walletConnection.starkSigner.getAddress();
-
     const completeWithdrawalResponse = await client.completeWithdrawal(
-      walletConnection.ethSigner,
-      starkPublicKey,
+      walletConnection,
       {
         type: 'ERC20',
         tokenAddress: '',

examples/completeEthWithdrawal.ts

@@ -7,11 +7,8 @@ import { generateWalletConnection } from './libs/walletConnection';
 
     const client = new ImmutableX(Config.SANDBOX);
 
-    const starkPublicKey = await walletConnection.starkSigner.getAddress();
-
     const completeWithdrawalResponse = await client.completeWithdrawal(
-      walletConnection.ethSigner,
-      starkPublicKey,
+      walletConnection,
       {
         type: 'ETH',
       },

examples/completeNftWithdrawal.ts

@@ -7,11 +7,8 @@ import { generateWalletConnection } from './libs/walletConnection';
 
     const client = new ImmutableX(Config.SANDBOX);
 
-    const starkPublicKey = await walletConnection.starkSigner.getAddress();
-
     const completeWithdrawalResponse = await client.completeWithdrawal(
-      walletConnection.ethSigner,
-      starkPublicKey,
+      walletConnection,
       {
         type: 'ERC721',
         tokenAddress: '',

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@imtbl/core-sdk",
-  "version": "2.5.4",
+  "version": "2.7.0",
   "description": "Immutable Core SDK",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",

src/ImmutableX.ts

@@ -592,19 +592,17 @@ export class ImmutableX {
 
   /**
    * Completes a Withdrawal
-   * @param ethSigner - the L1 signer
-   * @param starkPublicKey - the Signer address
+   * @param walletConnection - the pair of L1/L2 signers
    * @param token - the token
    * @returns a promise that resolves with the transaction
    * @throws {@link index.IMXError}
    */
   public completeWithdrawal(
-    ethSigner: EthSigner,
-    starkPublicKey: string,
+    walletConnection: WalletConnection,
     token: AnyToken,
   ) {
     return this.workflows
-      .completeWithdrawal(ethSigner, starkPublicKey, token)
+      .completeWithdrawal(walletConnection, token)
       .catch(err => {
         throw formatError(err);
       });

src/contracts/contracts/Core.ts → src/contracts/contracts/StarkV3.ts

@@ -27,7 +27,7 @@ import type {
   OnEvent,
 } from "../common";
 
-export interface CoreInterface extends utils.Interface {
+export interface StarkV3Interface extends utils.Interface {
   functions: {
     "announceAvailabilityVerifierRemovalIntent(address)": FunctionFragment;
     "announceVerifierRemovalIntent(address)": FunctionFragment;
@@ -864,12 +864,12 @@ export type LogWithdrawalPerformedEvent = TypedEvent<
 export type LogWithdrawalPerformedEventFilter =
   TypedEventFilter<LogWithdrawalPerformedEvent>;
 
-export interface Core extends BaseContract {
+export interface StarkV3 extends BaseContract {
   connect(signerOrProvider: Signer | Provider | string): this;
   attach(addressOrName: string): this;
   deployed(): Promise<this>;
 
-  interface: CoreInterface;
+  interface: StarkV3Interface;
 
   queryFilter<TEvent extends TypedEvent>(
     event: TypedEventFilter<TEvent>,