@boostxyz/sdk 0.0.0-alpha.20 → 0.0.0-alpha.21

package/src/BoostCore.test.ts

@@ -1,6 +1,4 @@
-import { loadFixture } from '@nomicfoundation/hardhat-toolbox-viem/network-helpers';
-import { pad, parseEther, zeroAddress } from 'viem';
-import { beforeAll, beforeEach, describe, expect, test, vi } from 'vitest';
+import { accounts } from '@boostxyz/test/accounts';
 import {
   type BudgetFixtures,
   type Fixtures,
@@ -10,13 +8,15 @@ import {
   fundBudget,
   makeMockEventActionPayload,
 } from '@boostxyz/test/helpers';
+import { loadFixture } from '@nomicfoundation/hardhat-toolbox-viem/network-helpers';
+import { pad, parseEther, zeroAddress } from 'viem';
+import { beforeAll, beforeEach, describe, expect, test, vi } from 'vitest';
 import { ContractAction } from './Actions/ContractAction';
+import { BOOST_CORE_CLAIM_FEE } from './BoostCore';
 import type { ERC20Incentive } from './Incentives/ERC20Incentive';
 import { StrategyType } from './claiming';
-import { IncentiveNotCloneableError } from './errors';
+import { BoostNotFoundError, IncentiveNotCloneableError } from './errors';
 import { bytes4 } from './utils';
-import { BOOST_CORE_CLAIM_FEE } from './BoostCore';
-import { accounts } from '@boostxyz/test/accounts';
 
 let fixtures: Fixtures, budgets: BudgetFixtures;
 
@@ -33,8 +33,7 @@ describe('BoostCore', () => {
 
     const { budget, erc20 } = budgets;
     await core.createBoost({
-      protocolFee: 1n,
-      referralFee: 2n,
+      protocolFee: 0n,
       maxParticipants: 100n,
       budget: budget,
       action: core.EventAction(
@@ -57,18 +56,28 @@ describe('BoostCore', () => {
           reward: parseEther('1'),
           limit: 100n,
           strategy: StrategyType.POOL,
+          manager: budget.assertValidAddress(),
         }),
       ],
     });
     expect(await core.getBoostCount()).toBe(1n);
   });
 
+  test('throws a typed error if no boost exists', async () => {
+    const { core } = fixtures;
+    try {
+      await core.getBoost(1000n)
+    } catch(e) {
+      expect(e instanceof BoostNotFoundError).toBe(true)
+      expect(e.id).toBe('1000')
+    }
+  })
+
   test('can successfully create a boost using all base contract implementations', async () => {
     const { core } = fixtures;
     const { budget, erc20 } = budgets;
     const boost = await core.createBoost({
       protocolFee: 1n,
-      referralFee: 2n,
       maxParticipants: 100n,
       budget: budget,
       action: core.EventAction(
@@ -91,6 +100,7 @@ describe('BoostCore', () => {
           reward: parseEther('1'),
           limit: 100n,
           strategy: StrategyType.POOL,
+          manager: budget.assertValidAddress(),
         }),
       ],
     });
@@ -98,7 +108,6 @@ describe('BoostCore', () => {
 
     expect(boost.owner).toBe(onChainBoost.owner);
     expect(boost.protocolFee).toBe(onChainBoost.protocolFee);
-    expect(boost.referralFee).toBe(onChainBoost.referralFee);
     expect(boost.maxParticipants).toBe(onChainBoost.maxParticipants);
 
     expect(boost.action.address).toBe(onChainBoost.action);
@@ -151,7 +160,6 @@ describe('BoostCore', () => {
     const { budget, erc20 } = budgets;
     const _boost = await core.createBoost({
       protocolFee: 1n,
-      referralFee: 2n,
       maxParticipants: 100n,
       budget: budget,
       action: core.EventAction(
@@ -174,12 +182,12 @@ describe('BoostCore', () => {
           reward: parseEther('1'),
           limit: 100n,
           strategy: StrategyType.POOL,
+          manager: budget.assertValidAddress(),
         }),
       ],
     });
     const boost = await core.readBoost(_boost.id);
     expect(boost.protocolFee).toBe(1001n);
-    expect(boost.referralFee).toBe(1002n);
     expect(boost.maxParticipants).toBe(100n);
     expect(boost.budget).toBe(_boost.budget.assertValidAddress());
     expect(boost.action).toBe(_boost.action.assertValidAddress());
@@ -190,15 +198,76 @@ describe('BoostCore', () => {
     );
   });
 
+  test('can optionally supply a validator', async () => {
+    const { core } = fixtures;
+    const { budget, erc20 } = budgets;
+    const _boost = await core.createBoost({
+      protocolFee: 1n,
+      maxParticipants: 100n,
+      budget: budget,
+      action: core.EventAction(
+        makeMockEventActionPayload(
+          core.assertValidAddress(),
+          erc20.assertValidAddress(),
+        ),
+      ),
+      allowList: core.SimpleAllowList({
+        owner: defaultOptions.account.address,
+        allowed: [defaultOptions.account.address],
+      }),
+      incentives: [
+        core.ERC20Incentive({
+          asset: erc20.assertValidAddress(),
+          reward: parseEther('1'),
+          limit: 100n,
+          strategy: StrategyType.POOL,
+          manager: budget.assertValidAddress(),
+        }),
+      ],
+    });
+    const boost = await core.readBoost(_boost.id);
+    expect(boost.validator).toBe(_boost.validator.assertValidAddress());
+  });
+
+  test('can simulate a boost creation', async () => {
+    const { core } = fixtures;
+    const { budget, erc20 } = budgets;
+    const simulated = await core.simulateCreateBoost({
+      protocolFee: 1n,
+      maxParticipants: 100n,
+      budget: budget,
+      action: core.EventAction(
+        makeMockEventActionPayload(
+          core.assertValidAddress(),
+          erc20.assertValidAddress(),
+        ),
+      ),
+      allowList: core.SimpleAllowList({
+        owner: defaultOptions.account.address,
+        allowed: [defaultOptions.account.address],
+      }),
+      incentives: [
+        core.ERC20Incentive({
+          asset: erc20.assertValidAddress(),
+          reward: parseEther('1'),
+          limit: 100n,
+          strategy: StrategyType.POOL,
+          manager: budget.assertValidAddress(),
+        }),
+      ],
+    });
+    expect(simulated.request.__mode).toBe('prepared')
+  });
+
   test('can reuse an existing action', async () => {
     const { core } = fixtures;
     const { budget, erc20 } = budgets;
 
     // allocate more funds to the budget
-    await erc20.mint(defaultOptions.account.address, parseEther('100'));
-    await erc20.approve(budget.assertValidAddress(), parseEther('100'));
+    await erc20.mint(defaultOptions.account.address, parseEther('110'));
+    await erc20.approve(budget.assertValidAddress(), parseEther('110'));
     await budget.allocate({
-      amount: parseEther('100'),
+      amount: parseEther('110'),
       asset: erc20.assertValidAddress(),
       target: defaultOptions.account.address,
     });
@@ -225,6 +294,7 @@ describe('BoostCore', () => {
           reward: parseEther('1'),
           limit: 100n,
           strategy: StrategyType.POOL,
+          manager: budget.assertValidAddress(),
         }),
       ],
     });
@@ -245,6 +315,7 @@ describe('BoostCore', () => {
           reward: parseEther('1'),
           limit: 100n,
           strategy: StrategyType.POOL,
+          manager: budget.assertValidAddress(),
         }),
       ],
     });
@@ -257,10 +328,10 @@ describe('BoostCore', () => {
     const { budget, erc20 } = budgets;
 
     // allocate more erc20 funds to the budget from the owning accound
-    await erc20.mint(defaultOptions.account.address, parseEther('100'));
-    await erc20.approve(budget.assertValidAddress(), parseEther('100'));
+    await erc20.mint(defaultOptions.account.address, parseEther('110'));
+    await erc20.approve(budget.assertValidAddress(), parseEther('110'));
     await budget.allocate({
-      amount: parseEther('100'),
+      amount: parseEther('110'),
       asset: erc20.assertValidAddress(),
       target: defaultOptions.account.address,
     });
@@ -287,6 +358,7 @@ describe('BoostCore', () => {
           reward: parseEther('1'),
           limit: 100n,
           strategy: StrategyType.POOL,
+          manager: budget.assertValidAddress(),
         }),
       ],
     });
@@ -312,6 +384,7 @@ describe('BoostCore', () => {
           reward: parseEther('1'),
           limit: 100n,
           strategy: StrategyType.POOL,
+          manager: budget.assertValidAddress(),
         }),
       ],
     });
@@ -324,10 +397,10 @@ describe('BoostCore', () => {
     const { budget, erc20 } = budgets;
 
     // allocate more erc20 funds to the budget from the owning accound
-    await erc20.mint(defaultOptions.account.address, parseEther('100'));
-    await erc20.approve(budget.assertValidAddress(), parseEther('100'));
+    await erc20.mint(defaultOptions.account.address, parseEther('110'));
+    await erc20.approve(budget.assertValidAddress(), parseEther('110'));
     await budget.allocate({
-      amount: parseEther('100'),
+      amount: parseEther('110'),
       asset: erc20.assertValidAddress(),
       target: defaultOptions.account.address,
     });
@@ -354,6 +427,7 @@ describe('BoostCore', () => {
           reward: parseEther('1'),
           limit: 100n,
           strategy: StrategyType.POOL,
+          manager: budget.assertValidAddress(),
         }),
       ],
     });
@@ -379,6 +453,7 @@ describe('BoostCore', () => {
           reward: parseEther('1'),
           limit: 100n,
           strategy: StrategyType.POOL,
+          manager: budget.assertValidAddress(),
         }),
       ],
     });
@@ -391,10 +466,10 @@ describe('BoostCore', () => {
     const { budget, erc20 } = budgets;
 
     // allocate more erc20 funds to the budget from the owning accound
-    await erc20.mint(defaultOptions.account.address, parseEther('100'));
-    await erc20.approve(budget.assertValidAddress(), parseEther('100'));
+    await erc20.mint(defaultOptions.account.address, parseEther('110'));
+    await erc20.approve(budget.assertValidAddress(), parseEther('110'));
     await budget.allocate({
-      amount: parseEther('100'),
+      amount: parseEther('110'),
       asset: erc20.assertValidAddress(),
       target: defaultOptions.account.address,
     });
@@ -404,6 +479,7 @@ describe('BoostCore', () => {
       reward: parseEther('1'),
       limit: 100n,
       strategy: StrategyType.POOL,
+          manager: budget.assertValidAddress(),
     });
     const _boost = await core.createBoost({
       budget: budget,
@@ -463,6 +539,7 @@ describe('BoostCore', () => {
       reward: 1n,
       limit: 10n,
       strategy: StrategyType.POOL,
+      manager: budget.assertValidAddress(),
     });
     // const erc1155Incentive = core.ERC1155Incentive({
     //   asset: erc1155.assertValidAddress(),
@@ -477,6 +554,7 @@ describe('BoostCore', () => {
       totalBudget: 10n,
       rewardBoost: 1n,
       rewardDecay: 1n,
+      manager: budget.assertValidAddress(),
     });
     const allowListIncentive = core.AllowListIncentive({
       allowList: allowList.assertValidAddress(),
@@ -491,7 +569,6 @@ describe('BoostCore', () => {
 
     await core.createBoost({
       protocolFee: 1n,
-      referralFee: 2n,
       maxParticipants: 100n,
       budget: budget,
       action: core.EventAction(
@@ -551,20 +628,6 @@ describe('BoostCore', () => {
     expect(await core.protocolFeeReceiver()).toBe(zeroAddress);
   });
 
-  test('can get the claim fee', async () => {
-    const { core } = fixtures;
-
-    expect(await core.claimFee()).toBe(75000000000000n);
-  });
-
-  test('can set the claim fee', async () => {
-    const { core } = fixtures;
-
-    await core.setClaimFee(100n);
-
-    expect(await core.claimFee()).toBe(100n);
-  });
-
   test('binds all actions, budgets, allowlists, incentives, and validators to reuse core options and account', () => {
     const { core } = fixtures;
 
@@ -613,6 +676,7 @@ describe('BoostCore', () => {
       rewardDecay: 0n,
       rewardBoost: 0n,
       totalBudget: 0n,
+      manager: zeroAddress,
     });
     expect(cgdaIncentive._config).toEqual(defaultOptions.config);
     expect(cgdaIncentive._account).toEqual(defaultOptions.account);
@@ -666,7 +730,6 @@ describe('BoostCore', () => {
     const { budget, erc20 } = budgets;
     await core.createBoost({
       protocolFee: 1n,
-      referralFee: 2n,
       maxParticipants: 100n,
       budget: budget,
       action: core.EventAction(
@@ -689,6 +752,7 @@ describe('BoostCore', () => {
           reward: parseEther('1'),
           limit: 100n,
           strategy: StrategyType.POOL,
+          manager: budget.assertValidAddress(),
         }),
       ],
     });
@@ -739,6 +803,7 @@ describe('BoostCore', () => {
           reward: parseEther('1'),
           limit: 100n,
           strategy: StrategyType.POOL,
+          manager: budget.assertValidAddress(),
         }),
       ],
     });
@@ -767,6 +832,7 @@ describe('BoostCore', () => {
           reward: parseEther('1'),
           limit: 100n,
           strategy: StrategyType.POOL,
+          manager: budget.assertValidAddress(),
         }),
       ],
     });
@@ -792,6 +858,7 @@ describe('BoostCore', () => {
       strategy: StrategyType.POOL,
       reward: 1n,
       limit: 1n,
+      manager: budgets.budget.assertValidAddress(),
     });
     const boost = await freshBoost(fixtures, {
       budget: budgets.budget,
@@ -810,7 +877,7 @@ describe('BoostCore', () => {
       boostId: boost.id,
     });
 
-    const {hash} = await fixtures.core.claimIncentiveRaw(
+    const { hash } = await fixtures.core.claimIncentiveRaw(
       boost.id,
       0n,
       referrer,
@@ -818,10 +885,10 @@ describe('BoostCore', () => {
       { value: BOOST_CORE_CLAIM_FEE },
     );
 
-    const claimInfo = await fixtures.core.getClaimFromTransaction({ hash })
-    expect(claimInfo).toBeDefined()
-    expect(claimInfo?.claimant).toBe(claimant)
-    expect(typeof claimInfo?.boostId).toBe('bigint')
-    expect(claimInfo?.referrer).toBe(referrer)
+    const claimInfo = await fixtures.core.getClaimFromTransaction({ hash });
+    expect(claimInfo).toBeDefined();
+    expect(claimInfo?.claimant).toBe(claimant);
+    expect(typeof claimInfo?.boostId).toBe('bigint');
+    expect(claimInfo?.referrer).toBe(referrer);
   });
 });