@whetstone-research/doppler-sdk 1.0.5 → 1.0.7

package/README.md

@@ -88,6 +88,19 @@ const params = new StaticAuctionBuilder()
     // Optional: specify multiple recipients and amounts
     // recipients: ['0xTeam...', '0xAdvisor...'],
     // amounts: [parseEther('50000000'), parseEther('50000000')]
+    // 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...')
@@ -98,7 +111,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 `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).
 
 > **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,13 +5294,29 @@ var DopplerFactory = class {
     this.walletClient = walletClient;
     this.chainId = chainId;
   }
+  hasCustomV2Schedules(vesting) {
+    return (vesting?.allocations?.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) {
       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,
@@ -5311,6 +5328,56 @@ var DopplerFactory = class {
       amounts: [args.sale.initialSupply - args.sale.numTokensToSell]
     };
   }
+  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 = [];
+    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);
+    }
+    return { schedules, scheduleIds };
+  }
   resolveStandardTokenFactoryMode(args) {
     if (this.usesDerc20V2Vesting(args.vesting)) {
       return "v2";
@@ -5352,12 +5419,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 +5432,7 @@ var DopplerFactory = class {
         yearlyMintRate,
         schedules,
         beneficiaries: recipients,
-        scheduleIds: recipients.map(() => 0n),
+        scheduleIds,
         amounts,
         tokenURI: args.token.tokenURI,
         implementation
@@ -8154,19 +8219,49 @@ 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 || vesting.recipients !== void 0 || vesting.amounts !== void 0)) {
       throw new Error(
-        `Vesting duration must be 0 or at least ${DERC20_V2_MIN_VESTING_DURATION} seconds when using cliffs`
+        "Use vesting.allocations instead of top-level duration/cliffDuration/recipients/amounts when configuring per-beneficiary vesting"
+      );
+    }
+    const availableForVesting = sale.initialSupply - sale.numTokensToSell;
+    if (vesting.allocations) {
+      if (vesting.allocations.length === 0) {
+        throw new Error("Vesting allocations array cannot be empty");
+      }
+      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})`
+        );
+      }
+      for (const [index, allocation] of vesting.allocations.entries()) {
+        const scheduleCliff = allocation.schedule.cliffDuration ?? 0;
+        const scheduleDuration = allocation.schedule.duration ?? 0;
+        this.validateUint64LikeNumber(
+          scheduleCliff,
+          `Vesting allocations[${index}].schedule.cliffDuration`
+        );
+        this.validateUint64LikeNumber(
+          scheduleDuration,
+          `Vesting allocations[${index}].schedule.duration`
+        );
+        if (scheduleCliff > scheduleDuration) {
+          throw new Error(
+            `Vesting allocations[${index}].schedule.cliffDuration cannot exceed duration`
+          );
+        }
+        if (scheduleCliff > 0 && scheduleDuration > 0 && scheduleDuration < DERC20_V2_MIN_VESTING_DURATION) {
+          throw new Error(
+            `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) {
@@ -8178,17 +8273,30 @@ var DopplerFactory = class {
         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;
       if (totalVested > availableForVesting) {
         throw new Error(
           `Total vesting amount (${totalVested}) exceeds available tokens (${availableForVesting})`
         );
       }
-      return;
+    } else {
+      const vestedAmount = sale.initialSupply - sale.numTokensToSell;
+      if (vestedAmount <= 0n) {
+        throw new Error("No tokens available for vesting");
+      }
     }
-    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 +8337,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 +13531,26 @@ 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 normalizeBuilderVestingSchedule(schedule, fieldPath) {
+  return {
+    duration: normalizeBuilderVestingScheduleDuration(
+      schedule.duration,
+      `${fieldPath}.duration`
+    ),
+    cliffDuration: schedule.cliffDuration ?? 0
+  };
+}
 function computeTicks(priceRange, tickSpacing) {
   const startTick = Math.floor(
     Math.log(priceRange.startPrice) / Math.log(1.0001) / tickSpacing
@@ -13719,6 +13846,19 @@ var StaticAuctionBuilder = class _StaticAuctionBuilder {
       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 ?? DEFAULT_V3_VESTING_DURATION),
       cliffDuration: params.cliffDuration ?? 0,
@@ -14051,6 +14191,19 @@ 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,
@@ -14657,6 +14810,19 @@ 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,
@@ -15046,6 +15212,19 @@ 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,