@whetstone-research/doppler-sdk 1.0.5 → 1.0.6

package/README.md

@@ -88,6 +88,13 @@ const params = new StaticAuctionBuilder()
     // Optional: specify multiple recipients and amounts
     // recipients: ['0xTeam...', '0xAdvisor...'],
     // amounts: [parseEther('50000000'), parseEther('50000000')]
+    // Optional: define per-beneficiary schedules on the DERC20 V2 path
+    // schedules: [
+    //   { duration: BigInt(180 * 24 * 60 * 60), cliffDuration: 30 * 24 * 60 * 60 },
+    //   { duration: BigInt(365 * 24 * 60 * 60), cliffDuration: 90 * 24 * 60 * 60 },
+    // ],
+    // Optional: if omitted, one schedule is assigned per recipient in order
+    // scheduleIds: [0, 1]
   })
   .withMigration({ type: 'uniswapV2' })
   .withUserAddress('0x...')
@@ -98,7 +105,9 @@ console.log('Pool address:', result.poolAddress);
 console.log('Token address:', result.tokenAddress);
 ```
 
-If you set `cliffDuration > 0`, the SDK now automatically uses the DERC20 V2 factory and exposes schedule-aware token reads via `sdk.getDerc20V2(tokenAddress)`.
+If you set `cliffDuration > 0` or provide `schedules`, the SDK automatically uses the DERC20 V2 factory and exposes schedule-aware token reads via `sdk.getDerc20V2(tokenAddress)`. When `schedules` is provided, omit `scheduleIds` to assign one schedule per recipient in order, or provide `scheduleIds` to reuse schedules across beneficiaries.
+
+For a runnable example, see [examples/multicurve-per-beneficiary-vesting.ts](./examples/multicurve-per-beneficiary-vesting.ts).
 
 > **Tick spacing reminder:** When you provide ticks manually via `poolByTicks`, make sure both `startTick` and `endTick` are exact multiples of the fee tier's tick spacing (100→1, 500→10, 3000→60, 10000→200). The SDK now validates this locally and will fail fast if the ticks are misaligned.
 

package/dist/evm/index.cjs

@@ -5282,6 +5282,7 @@ var erc20BalanceOfAbi = [
 ];
 var TOKEN_FACTORY_80_ADDRESS2 = "0xf0b5141dd9096254b2ca624dff26024f46087229";
 var DERC20_V2_MIN_VESTING_DURATION = 24 * 60 * 60;
+var MAX_UINT64 = (1n << 64n) - 1n;
 var DopplerFactory = class {
   publicClient;
   walletClient;
@@ -5293,8 +5294,14 @@ var DopplerFactory = class {
     this.walletClient = walletClient;
     this.chainId = chainId;
   }
+  hasCustomV2Schedules(vesting) {
+    return (vesting?.schedules?.length ?? 0) > 0 || (vesting?.scheduleIds?.length ?? 0) > 0;
+  }
   usesDerc20V2Vesting(vesting) {
-    return (vesting?.cliffDuration ?? 0) > 0;
+    if (!vesting) {
+      return false;
+    }
+    return this.hasCustomV2Schedules(vesting) || (vesting.cliffDuration ?? 0) > 0;
   }
   resolveVestingAllocations(args) {
     if (!args.vesting) {
@@ -5311,6 +5318,83 @@ var DopplerFactory = class {
       amounts: [args.sale.initialSupply - args.sale.numTokensToSell]
     };
   }
+  normalizeV2ScheduleId(scheduleId, label) {
+    if (!Number.isFinite(scheduleId) || !Number.isInteger(scheduleId)) {
+      throw new Error(`${label} must be an integer`);
+    }
+    if (!Number.isSafeInteger(scheduleId)) {
+      throw new Error(`${label} must be a safe integer`);
+    }
+    if (scheduleId < 0) {
+      throw new Error(`${label} cannot be negative`);
+    }
+    return BigInt(scheduleId);
+  }
+  validateUint64LikeNumber(value, fieldPath, options = {}) {
+    const { allowZero = true } = options;
+    if (!Number.isFinite(value) || !Number.isInteger(value)) {
+      throw new Error(`${fieldPath} must be a finite integer`);
+    }
+    if (!Number.isSafeInteger(value)) {
+      throw new Error(`${fieldPath} must be a safe integer`);
+    }
+    if (value < 0) {
+      throw new Error(`${fieldPath} cannot be negative`);
+    }
+    if (!allowZero && value === 0) {
+      throw new Error(`${fieldPath} must be greater than zero`);
+    }
+    if (BigInt(value) > MAX_UINT64) {
+      throw new Error(`${fieldPath} must fit in uint64`);
+    }
+  }
+  resolveV2VestingSchedules(args) {
+    if (!args.vesting) {
+      return { schedules: [], scheduleIds: [] };
+    }
+    if (!this.hasCustomV2Schedules(args.vesting)) {
+      return {
+        schedules: [
+          {
+            cliff: BigInt(args.vesting.cliffDuration ?? 0),
+            duration: BigInt(args.vesting.duration ?? 0)
+          }
+        ],
+        scheduleIds: Array.from({ length: args.recipientCount }, () => 0n)
+      };
+    }
+    const schedules = args.vesting.schedules?.map((schedule) => ({
+      cliff: BigInt(schedule.cliffDuration ?? 0),
+      duration: BigInt(schedule.duration ?? 0)
+    })) ?? [];
+    const explicitScheduleIds = args.vesting.scheduleIds;
+    if (explicitScheduleIds && explicitScheduleIds.length > 0) {
+      return {
+        schedules,
+        scheduleIds: explicitScheduleIds.map(
+          (scheduleId, index) => this.normalizeV2ScheduleId(
+            scheduleId,
+            `Vesting scheduleIds[${index}]`
+          )
+        )
+      };
+    }
+    if (schedules.length === 1) {
+      return {
+        schedules,
+        scheduleIds: Array.from({ length: args.recipientCount }, () => 0n)
+      };
+    }
+    if (schedules.length === args.recipientCount) {
+      return {
+        schedules,
+        scheduleIds: schedules.map((_, index) => BigInt(index))
+      };
+    }
+    throw new Error(
+      "Vesting schedules must either contain exactly one shared schedule or one schedule per recipient when scheduleIds are omitted"
+    );
+  }
   resolveStandardTokenFactoryMode(args) {
     if (this.usesDerc20V2Vesting(args.vesting)) {
       return "v2";
@@ -5352,12 +5436,10 @@ var DopplerFactory = class {
           "DERC20 V2 implementation address not configured for this chain."
         );
       }
-      const schedules = args.vesting === void 0 ? [] : [
-        {
-          cliff: BigInt(args.vesting.cliffDuration ?? 0),
-          duration: BigInt(args.vesting.duration ?? 0)
-        }
-      ];
+      const { schedules, scheduleIds } = this.resolveV2VestingSchedules({
+        vesting: args.vesting,
+        recipientCount: recipients.length
+      });
       return {
         kind: "v2",
         name: args.token.name,
@@ -5367,7 +5449,7 @@ var DopplerFactory = class {
         yearlyMintRate,
         schedules,
         beneficiaries: recipients,
-        scheduleIds: recipients.map(() => 0n),
+        scheduleIds,
         amounts,
         tokenURI: args.token.tokenURI,
         implementation
@@ -8154,18 +8236,10 @@ var DopplerFactory = class {
     }
     const cliffDuration = vesting.cliffDuration ?? 0;
     const duration = vesting.duration ?? 0;
-    if (cliffDuration < 0) {
-      throw new Error("Vesting cliff duration cannot be negative");
-    }
-    if (duration < 0) {
-      throw new Error("Vesting duration cannot be negative");
-    }
-    if (cliffDuration > duration) {
-      throw new Error("Vesting cliff duration cannot exceed vesting duration");
-    }
-    if (cliffDuration > 0 && duration > 0 && duration < DERC20_V2_MIN_VESTING_DURATION) {
+    const hasCustomSchedules = this.hasCustomV2Schedules(vesting);
+    if (hasCustomSchedules && (cliffDuration > 0 || duration > 0)) {
       throw new Error(
-        `Vesting duration must be 0 or at least ${DERC20_V2_MIN_VESTING_DURATION} seconds when using cliffs`
+        "Use vesting.schedules instead of top-level duration/cliffDuration when configuring multiple vesting schedules"
       );
     }
     if (vesting.recipients && vesting.amounts) {
@@ -8184,11 +8258,79 @@ var DopplerFactory = class {
           `Total vesting amount (${totalVested}) exceeds available tokens (${availableForVesting})`
         );
       }
+    } else {
+      const vestedAmount = sale.initialSupply - sale.numTokensToSell;
+      if (vestedAmount <= 0n) {
+        throw new Error("No tokens available for vesting");
+      }
+    }
+    if (hasCustomSchedules) {
+      const schedules = vesting.schedules;
+      if (!schedules || schedules.length === 0) {
+        throw new Error(
+          "Vesting schedules are required when using scheduleIds or multiple vesting schedules"
+        );
+      }
+      const recipientCount = vesting.recipients && vesting.amounts ? vesting.recipients.length : 1;
+      if (vesting.scheduleIds) {
+        if (vesting.scheduleIds.length !== recipientCount) {
+          throw new Error(
+            "Vesting scheduleIds array must have the same length as vesting recipients"
+          );
+        }
+        for (const [index, scheduleId] of vesting.scheduleIds.entries()) {
+          this.validateUint64LikeNumber(
+            scheduleId,
+            `Vesting scheduleIds[${index}]`
+          );
+          if (scheduleId >= schedules.length) {
+            throw new Error(
+              `Vesting scheduleIds[${index}] references missing schedule ${scheduleId}`
+            );
+          }
+        }
+      } else if (schedules.length !== 1 && schedules.length !== recipientCount) {
+        throw new Error(
+          "Vesting schedules must either contain exactly one shared schedule or one schedule per recipient when scheduleIds are omitted"
+        );
+      }
+      for (const [index, schedule] of schedules.entries()) {
+        const scheduleCliff = schedule.cliffDuration ?? 0;
+        const scheduleDuration = schedule.duration ?? 0;
+        this.validateUint64LikeNumber(
+          scheduleCliff,
+          `Vesting schedules[${index}].cliffDuration`
+        );
+        this.validateUint64LikeNumber(
+          scheduleDuration,
+          `Vesting schedules[${index}].duration`
+        );
+        if (scheduleCliff > scheduleDuration) {
+          throw new Error(
+            `Vesting schedules[${index}].cliffDuration cannot exceed duration`
+          );
+        }
+        if (scheduleCliff > 0 && scheduleDuration > 0 && scheduleDuration < DERC20_V2_MIN_VESTING_DURATION) {
+          throw new Error(
+            `Vesting schedules[${index}].duration must be 0 or at least ${DERC20_V2_MIN_VESTING_DURATION} seconds when using cliffs`
+          );
+        }
+      }
       return;
     }
-    const vestedAmount = sale.initialSupply - sale.numTokensToSell;
-    if (vestedAmount <= 0n) {
-      throw new Error("No tokens available for vesting");
+    if (cliffDuration < 0) {
+      throw new Error("Vesting cliff duration cannot be negative");
+    }
+    if (duration < 0) {
+      throw new Error("Vesting duration cannot be negative");
+    }
+    if (cliffDuration > duration) {
+      throw new Error("Vesting cliff duration cannot exceed vesting duration");
+    }
+    if (cliffDuration > 0 && duration > 0 && duration < DERC20_V2_MIN_VESTING_DURATION) {
+      throw new Error(
+        `Vesting duration must be 0 or at least ${DERC20_V2_MIN_VESTING_DURATION} seconds when using cliffs`
+      );
     }
   }
   validateStaticAuctionParams(params) {
@@ -8229,7 +8371,6 @@ var DopplerFactory = class {
       throw new Error("Cannot sell more tokens than initial supply");
     }
     this.validateVestingConfig(params.sale, params.vesting);
-    this.validateVestingConfig(params.sale, params.vesting);
     if (params.migration.type === "dopplerHook") {
       throw new Error(
         "dopplerHook migration is only supported for dynamic auctions"
@@ -13424,6 +13565,35 @@ var Eth = class {
 };
 
 // src/evm/builders/shared.ts
+var MAX_SAFE_INTEGER_BIGINT = BigInt(Number.MAX_SAFE_INTEGER);
+function normalizeBuilderVestingScheduleDuration(value, fieldPath) {
+  const duration = value ?? 0n;
+  if (duration < 0n) {
+    throw new RangeError(`${fieldPath} cannot be negative`);
+  }
+  if (duration > MAX_SAFE_INTEGER_BIGINT) {
+    throw new RangeError(`${fieldPath} must be a safe integer`);
+  }
+  return Number(duration);
+}
+function normalizeBuilderScheduleId(scheduleId, fieldPath) {
+  if (typeof scheduleId === "bigint") {
+    if (scheduleId < 0n) {
+      throw new RangeError(`${fieldPath} cannot be negative`);
+    }
+    if (scheduleId > MAX_SAFE_INTEGER_BIGINT) {
+      throw new RangeError(`${fieldPath} must be a safe integer`);
+    }
+    return Number(scheduleId);
+  }
+  if (!Number.isSafeInteger(scheduleId)) {
+    throw new RangeError(`${fieldPath} must be a safe integer`);
+  }
+  if (scheduleId < 0) {
+    throw new RangeError(`${fieldPath} cannot be negative`);
+  }
+  return scheduleId;
+}
 function computeTicks(priceRange, tickSpacing) {
   const startTick = Math.floor(
     Math.log(priceRange.startPrice) / Math.log(1.0001) / tickSpacing
@@ -13719,11 +13889,24 @@ var StaticAuctionBuilder = class _StaticAuctionBuilder {
       this.vesting = void 0;
       return this;
     }
+    const hasCustomSchedules = (params.schedules?.length ?? 0) > 0 || (params.scheduleIds?.length ?? 0) > 0;
     this.vesting = {
-      duration: Number(params.duration ?? DEFAULT_V3_VESTING_DURATION),
+      duration: Number(
+        params.duration ?? (hasCustomSchedules ? 0n : DEFAULT_V3_VESTING_DURATION)
+      ),
       cliffDuration: params.cliffDuration ?? 0,
       recipients: params.recipients,
-      amounts: params.amounts
+      amounts: params.amounts,
+      schedules: params.schedules?.map((schedule) => ({
+        duration: normalizeBuilderVestingScheduleDuration(
+          schedule.duration,
+          "Vesting schedule duration"
+        ),
+        cliffDuration: schedule.cliffDuration ?? 0
+      })),
+      scheduleIds: params.scheduleIds?.map(
+        (scheduleId, index) => normalizeBuilderScheduleId(scheduleId, `Vesting scheduleIds[${index}]`)
+      )
     };
     return this;
   }
@@ -14055,7 +14238,17 @@ var DynamicAuctionBuilder = class _DynamicAuctionBuilder {
       duration: Number(params.duration ?? 0n),
       cliffDuration: params.cliffDuration ?? 0,
       recipients: params.recipients,
-      amounts: params.amounts
+      amounts: params.amounts,
+      schedules: params.schedules?.map((schedule) => ({
+        duration: normalizeBuilderVestingScheduleDuration(
+          schedule.duration,
+          "Vesting schedule duration"
+        ),
+        cliffDuration: schedule.cliffDuration ?? 0
+      })),
+      scheduleIds: params.scheduleIds?.map(
+        (scheduleId, index) => normalizeBuilderScheduleId(scheduleId, `Vesting scheduleIds[${index}]`)
+      )
     };
     return this;
   }
@@ -14661,7 +14854,17 @@ var MulticurveBuilder = class _MulticurveBuilder {
       duration: Number(params.duration ?? 0n),
       cliffDuration: params.cliffDuration ?? 0,
       recipients: params.recipients,
-      amounts: params.amounts
+      amounts: params.amounts,
+      schedules: params.schedules?.map((schedule) => ({
+        duration: normalizeBuilderVestingScheduleDuration(
+          schedule.duration,
+          "Vesting schedule duration"
+        ),
+        cliffDuration: schedule.cliffDuration ?? 0
+      })),
+      scheduleIds: params.scheduleIds?.map(
+        (scheduleId, index) => normalizeBuilderScheduleId(scheduleId, `Vesting scheduleIds[${index}]`)
+      )
     };
     return this;
   }
@@ -15050,7 +15253,17 @@ var OpeningAuctionBuilder = class _OpeningAuctionBuilder {
       duration: Number(params.duration ?? 0n),
       cliffDuration: params.cliffDuration ?? 0,
       recipients: params.recipients,
-      amounts: params.amounts
+      amounts: params.amounts,
+      schedules: params.schedules?.map((schedule) => ({
+        duration: normalizeBuilderVestingScheduleDuration(
+          schedule.duration,
+          "Vesting schedule duration"
+        ),
+        cliffDuration: schedule.cliffDuration ?? 0
+      })),
+      scheduleIds: params.scheduleIds?.map(
+        (scheduleId, index) => normalizeBuilderScheduleId(scheduleId, `Vesting scheduleIds[${index}]`)
+      )
     };
     return this;
   }