@whetstone-research/doppler-sdk 1.0.6 → 1.0.7

package/README.md

@@ -88,13 +88,19 @@ 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]
+    // Optional: define per-beneficiary vesting allocations on the DERC20 V2 path
+    // allocations: [
+    //   {
+    //     recipient: '0xTeam...',
+    //     amount: parseEther('50000000'),
+    //     schedule: { duration: BigInt(180 * 24 * 60 * 60), cliffDuration: 30 * 24 * 60 * 60 },
+    //   },
+    //   {
+    //     recipient: '0xAdvisor...',
+    //     amount: parseEther('50000000'),
+    //     schedule: { duration: BigInt(365 * 24 * 60 * 60), cliffDuration: 90 * 24 * 60 * 60 },
+    //   },
+    // ]
   })
   .withMigration({ type: 'uniswapV2' })
   .withUserAddress('0x...')
@@ -105,7 +111,7 @@ console.log('Pool address:', result.poolAddress);
 console.log('Token address:', result.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.
+If you set `cliffDuration > 0` or provide `allocations`, the SDK automatically uses the DERC20 V2 factory and exposes schedule-aware token reads via `sdk.getDerc20V2(tokenAddress)`. When `allocations` is provided, the SDK dedupes identical schedules internally and maps each recipient to the correct on-chain schedule.
 
 For a runnable example, see [examples/multicurve-per-beneficiary-vesting.ts](./examples/multicurve-per-beneficiary-vesting.ts).
 

package/dist/evm/index.cjs

@@ -5295,7 +5295,7 @@ var DopplerFactory = class {
     this.chainId = chainId;
   }
   hasCustomV2Schedules(vesting) {
-    return (vesting?.schedules?.length ?? 0) > 0 || (vesting?.scheduleIds?.length ?? 0) > 0;
+    return (vesting?.allocations?.length ?? 0) > 0;
   }
   usesDerc20V2Vesting(vesting) {
     if (!vesting) {
@@ -5307,6 +5307,16 @@ var DopplerFactory = class {
     if (!args.vesting) {
       return { recipients: [], amounts: [] };
     }
+    if (args.vesting.allocations) {
+      return {
+        recipients: args.vesting.allocations.map(
+          (allocation) => allocation.recipient
+        ),
+        amounts: args.vesting.allocations.map(
+          (allocation) => allocation.amount
+        )
+      };
+    }
     if (args.vesting.recipients && args.vesting.amounts) {
       return {
         recipients: args.vesting.recipients,
@@ -5318,18 +5328,6 @@ 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)) {
@@ -5363,37 +5361,22 @@ var DopplerFactory = class {
         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))
-      };
+    const schedules = [];
+    const scheduleIds = [];
+    const scheduleIdsByKey = /* @__PURE__ */ new Map();
+    for (const allocation of args.vesting.allocations ?? []) {
+      const cliff = BigInt(allocation.schedule.cliffDuration ?? 0);
+      const duration = BigInt(allocation.schedule.duration ?? 0);
+      const key = `${cliff}:${duration}`;
+      let scheduleId = scheduleIdsByKey.get(key);
+      if (scheduleId === void 0) {
+        scheduleId = BigInt(schedules.length);
+        schedules.push({ cliff, duration });
+        scheduleIdsByKey.set(key, scheduleId);
+      }
+      scheduleIds.push(scheduleId);
     }
-    throw new Error(
-      "Vesting schedules must either contain exactly one shared schedule or one schedule per recipient when scheduleIds are omitted"
-    );
+    return { schedules, scheduleIds };
   }
   resolveStandardTokenFactoryMode(args) {
     if (this.usesDerc20V2Vesting(args.vesting)) {
@@ -8237,87 +8220,70 @@ var DopplerFactory = class {
     const cliffDuration = vesting.cliffDuration ?? 0;
     const duration = vesting.duration ?? 0;
     const hasCustomSchedules = this.hasCustomV2Schedules(vesting);
-    if (hasCustomSchedules && (cliffDuration > 0 || duration > 0)) {
+    if (hasCustomSchedules && (cliffDuration > 0 || duration > 0 || vesting.recipients !== void 0 || vesting.amounts !== void 0)) {
       throw new Error(
-        "Use vesting.schedules instead of top-level duration/cliffDuration when configuring multiple vesting schedules"
+        "Use vesting.allocations instead of top-level duration/cliffDuration/recipients/amounts when configuring per-beneficiary vesting"
       );
     }
-    if (vesting.recipients && vesting.amounts) {
-      if (vesting.recipients.length !== vesting.amounts.length) {
-        throw new Error(
-          "Vesting recipients and amounts arrays must have the same length"
-        );
+    const availableForVesting = sale.initialSupply - sale.numTokensToSell;
+    if (vesting.allocations) {
+      if (vesting.allocations.length === 0) {
+        throw new Error("Vesting allocations array cannot be empty");
       }
-      if (vesting.recipients.length === 0) {
-        throw new Error("Vesting recipients array cannot be empty");
-      }
-      const totalVested = vesting.amounts.reduce((sum, amt) => sum + amt, 0n);
-      const availableForVesting = sale.initialSupply - sale.numTokensToSell;
+      const totalVested = vesting.allocations.reduce(
+        (sum, allocation) => sum + allocation.amount,
+        0n
+      );
       if (totalVested > availableForVesting) {
         throw new Error(
           `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;
+      for (const [index, allocation] of vesting.allocations.entries()) {
+        const scheduleCliff = allocation.schedule.cliffDuration ?? 0;
+        const scheduleDuration = allocation.schedule.duration ?? 0;
         this.validateUint64LikeNumber(
           scheduleCliff,
-          `Vesting schedules[${index}].cliffDuration`
+          `Vesting allocations[${index}].schedule.cliffDuration`
         );
         this.validateUint64LikeNumber(
           scheduleDuration,
-          `Vesting schedules[${index}].duration`
+          `Vesting allocations[${index}].schedule.duration`
         );
         if (scheduleCliff > scheduleDuration) {
           throw new Error(
-            `Vesting schedules[${index}].cliffDuration cannot exceed duration`
+            `Vesting allocations[${index}].schedule.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`
+            `Vesting allocations[${index}].schedule.duration must be 0 or at least ${DERC20_V2_MIN_VESTING_DURATION} seconds when using cliffs`
           );
         }
       }
       return;
     }
+    if (vesting.recipients && vesting.amounts) {
+      if (vesting.recipients.length !== vesting.amounts.length) {
+        throw new Error(
+          "Vesting recipients and amounts arrays must have the same length"
+        );
+      }
+      if (vesting.recipients.length === 0) {
+        throw new Error("Vesting recipients array cannot be empty");
+      }
+      const totalVested = vesting.amounts.reduce((sum, amt) => sum + amt, 0n);
+      if (totalVested > availableForVesting) {
+        throw new Error(
+          `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 (cliffDuration < 0) {
       throw new Error("Vesting cliff duration cannot be negative");
     }
@@ -13576,23 +13542,14 @@ function normalizeBuilderVestingScheduleDuration(value, fieldPath) {
   }
   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 normalizeBuilderVestingSchedule(schedule, fieldPath) {
+  return {
+    duration: normalizeBuilderVestingScheduleDuration(
+      schedule.duration,
+      `${fieldPath}.duration`
+    ),
+    cliffDuration: schedule.cliffDuration ?? 0
+  };
 }
 function computeTicks(priceRange, tickSpacing) {
   const startTick = Math.floor(
@@ -13889,24 +13846,24 @@ var StaticAuctionBuilder = class _StaticAuctionBuilder {
       this.vesting = void 0;
       return this;
     }
-    const hasCustomSchedules = (params.schedules?.length ?? 0) > 0 || (params.scheduleIds?.length ?? 0) > 0;
+    if (params.allocations) {
+      this.vesting = {
+        allocations: params.allocations.map((allocation, index) => ({
+          recipient: allocation.recipient,
+          amount: allocation.amount,
+          schedule: normalizeBuilderVestingSchedule(
+            allocation.schedule,
+            `Vesting allocations[${index}].schedule`
+          )
+        }))
+      };
+      return this;
+    }
     this.vesting = {
-      duration: Number(
-        params.duration ?? (hasCustomSchedules ? 0n : DEFAULT_V3_VESTING_DURATION)
-      ),
+      duration: Number(params.duration ?? DEFAULT_V3_VESTING_DURATION),
       cliffDuration: params.cliffDuration ?? 0,
       recipients: params.recipients,
-      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}]`)
-      )
+      amounts: params.amounts
     };
     return this;
   }
@@ -14234,21 +14191,24 @@ var DynamicAuctionBuilder = class _DynamicAuctionBuilder {
       this.vesting = void 0;
       return this;
     }
+    if (params.allocations) {
+      this.vesting = {
+        allocations: params.allocations.map((allocation, index) => ({
+          recipient: allocation.recipient,
+          amount: allocation.amount,
+          schedule: normalizeBuilderVestingSchedule(
+            allocation.schedule,
+            `Vesting allocations[${index}].schedule`
+          )
+        }))
+      };
+      return this;
+    }
     this.vesting = {
       duration: Number(params.duration ?? 0n),
       cliffDuration: params.cliffDuration ?? 0,
       recipients: params.recipients,
-      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}]`)
-      )
+      amounts: params.amounts
     };
     return this;
   }
@@ -14850,21 +14810,24 @@ var MulticurveBuilder = class _MulticurveBuilder {
       this.vesting = void 0;
       return this;
     }
+    if (params.allocations) {
+      this.vesting = {
+        allocations: params.allocations.map((allocation, index) => ({
+          recipient: allocation.recipient,
+          amount: allocation.amount,
+          schedule: normalizeBuilderVestingSchedule(
+            allocation.schedule,
+            `Vesting allocations[${index}].schedule`
+          )
+        }))
+      };
+      return this;
+    }
     this.vesting = {
       duration: Number(params.duration ?? 0n),
       cliffDuration: params.cliffDuration ?? 0,
       recipients: params.recipients,
-      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}]`)
-      )
+      amounts: params.amounts
     };
     return this;
   }
@@ -15249,21 +15212,24 @@ var OpeningAuctionBuilder = class _OpeningAuctionBuilder {
       this.vesting = void 0;
       return this;
     }
+    if (params.allocations) {
+      this.vesting = {
+        allocations: params.allocations.map((allocation, index) => ({
+          recipient: allocation.recipient,
+          amount: allocation.amount,
+          schedule: normalizeBuilderVestingSchedule(
+            allocation.schedule,
+            `Vesting allocations[${index}].schedule`
+          )
+        }))
+      };
+      return this;
+    }
     this.vesting = {
       duration: Number(params.duration ?? 0n),
       cliffDuration: params.cliffDuration ?? 0,
       recipients: params.recipients,
-      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}]`)
-      )
+      amounts: params.amounts
     };
     return this;
   }