@boostxyz/sdk 6.1.3 → 7.0.0-canary.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (186) hide show
  1. package/README.md +1 -1
  2. package/dist/Actions/Action.cjs +1 -1
  3. package/dist/Actions/Action.js +7 -7
  4. package/dist/Actions/EventAction.cjs +1 -1
  5. package/dist/Actions/EventAction.cjs.map +1 -1
  6. package/dist/Actions/EventAction.d.ts +10 -0
  7. package/dist/Actions/EventAction.d.ts.map +1 -1
  8. package/dist/Actions/EventAction.js +77 -76
  9. package/dist/Actions/EventAction.js.map +1 -1
  10. package/dist/AllowLists/AllowList.cjs +1 -1
  11. package/dist/AllowLists/AllowList.js +5 -5
  12. package/dist/AllowLists/SimpleAllowList.cjs +1 -1
  13. package/dist/AllowLists/SimpleAllowList.cjs.map +1 -1
  14. package/dist/AllowLists/SimpleAllowList.js +17 -17
  15. package/dist/AllowLists/SimpleAllowList.js.map +1 -1
  16. package/dist/AllowLists/SimpleDenyList.cjs +1 -1
  17. package/dist/AllowLists/SimpleDenyList.js +3 -3
  18. package/dist/Auth/PassthroughAuth.cjs +1 -1
  19. package/dist/Auth/PassthroughAuth.js +1 -1
  20. package/dist/BoostCore.cjs +2 -2
  21. package/dist/BoostCore.cjs.map +1 -1
  22. package/dist/BoostCore.d.ts +1894 -267
  23. package/dist/BoostCore.d.ts.map +1 -1
  24. package/dist/BoostCore.js +831 -520
  25. package/dist/BoostCore.js.map +1 -1
  26. package/dist/BoostRegistry.cjs +1 -1
  27. package/dist/BoostRegistry.js +48 -48
  28. package/dist/Budget-BgGihcwx.js +1124 -0
  29. package/dist/Budget-BgGihcwx.js.map +1 -0
  30. package/dist/Budget-DYlTLLwg.cjs +2 -0
  31. package/dist/Budget-DYlTLLwg.cjs.map +1 -0
  32. package/dist/Budgets/Budget.cjs +1 -1
  33. package/dist/Budgets/Budget.d.ts +5 -4
  34. package/dist/Budgets/Budget.d.ts.map +1 -1
  35. package/dist/Budgets/Budget.js +9 -6
  36. package/dist/Budgets/ManagedBudget.cjs +1 -1
  37. package/dist/Budgets/ManagedBudget.cjs.map +1 -1
  38. package/dist/Budgets/ManagedBudget.d.ts +4 -0
  39. package/dist/Budgets/ManagedBudget.d.ts.map +1 -1
  40. package/dist/Budgets/ManagedBudget.js +22 -22
  41. package/dist/Budgets/ManagedBudgetWithFees.d.ts +4 -0
  42. package/dist/Budgets/ManagedBudgetWithFees.d.ts.map +1 -1
  43. package/dist/Budgets/ManagedBudgetWithFeesV2.d.ts +4 -0
  44. package/dist/Budgets/ManagedBudgetWithFeesV2.d.ts.map +1 -1
  45. package/dist/Budgets/TransparentBudget.d.ts +944 -0
  46. package/dist/Budgets/TransparentBudget.d.ts.map +1 -0
  47. package/dist/Budgets/VestingBudget.d.ts +4 -0
  48. package/dist/Budgets/VestingBudget.d.ts.map +1 -1
  49. package/dist/Deployable/Deployable.cjs.map +1 -1
  50. package/dist/Deployable/Deployable.d.ts +1 -1
  51. package/dist/Deployable/Deployable.d.ts.map +1 -1
  52. package/dist/Deployable/Deployable.js.map +1 -1
  53. package/dist/Deployable/DeployableTarget.cjs +1 -1
  54. package/dist/Deployable/DeployableTarget.js +1 -1
  55. package/dist/Deployable/DeployableTargetWithRBAC.cjs +1 -1
  56. package/dist/Deployable/DeployableTargetWithRBAC.js +20 -20
  57. package/dist/Incentive-BDqkFt0J.cjs +2 -0
  58. package/dist/Incentive-BDqkFt0J.cjs.map +1 -0
  59. package/dist/Incentive-DPOADY1f.js +449 -0
  60. package/dist/Incentive-DPOADY1f.js.map +1 -0
  61. package/dist/Incentives/AllowListIncentive.cjs +1 -1
  62. package/dist/Incentives/AllowListIncentive.cjs.map +1 -1
  63. package/dist/Incentives/AllowListIncentive.js +14 -14
  64. package/dist/Incentives/AllowListIncentive.js.map +1 -1
  65. package/dist/Incentives/CGDAIncentive.cjs +1 -1
  66. package/dist/Incentives/CGDAIncentive.cjs.map +1 -1
  67. package/dist/Incentives/CGDAIncentive.js +11 -11
  68. package/dist/Incentives/CGDAIncentive.js.map +1 -1
  69. package/dist/Incentives/ERC20Incentive.cjs +1 -1
  70. package/dist/Incentives/ERC20Incentive.cjs.map +1 -1
  71. package/dist/Incentives/ERC20Incentive.js +14 -14
  72. package/dist/Incentives/ERC20Incentive.js.map +1 -1
  73. package/dist/Incentives/ERC20PeggedIncentive.d.ts +1 -1
  74. package/dist/Incentives/ERC20PeggedVariableCriteriaIncentive.cjs +2 -0
  75. package/dist/Incentives/ERC20PeggedVariableCriteriaIncentive.cjs.map +1 -0
  76. package/dist/Incentives/ERC20PeggedVariableCriteriaIncentive.d.ts +3 -1
  77. package/dist/Incentives/ERC20PeggedVariableCriteriaIncentive.d.ts.map +1 -1
  78. package/dist/Incentives/ERC20PeggedVariableCriteriaIncentive.js +604 -0
  79. package/dist/Incentives/ERC20PeggedVariableCriteriaIncentive.js.map +1 -0
  80. package/dist/Incentives/ERC20PeggedVariableCriteriaIncentiveV2.cjs +2 -0
  81. package/dist/Incentives/ERC20PeggedVariableCriteriaIncentiveV2.cjs.map +1 -0
  82. package/dist/Incentives/ERC20PeggedVariableCriteriaIncentiveV2.d.ts +1103 -0
  83. package/dist/Incentives/ERC20PeggedVariableCriteriaIncentiveV2.d.ts.map +1 -0
  84. package/dist/Incentives/ERC20PeggedVariableCriteriaIncentiveV2.js +625 -0
  85. package/dist/Incentives/ERC20PeggedVariableCriteriaIncentiveV2.js.map +1 -0
  86. package/dist/Incentives/ERC20VariableCriteriaIncentive.cjs +1 -1
  87. package/dist/Incentives/ERC20VariableCriteriaIncentive.cjs.map +1 -1
  88. package/dist/Incentives/ERC20VariableCriteriaIncentive.d.ts +11 -1
  89. package/dist/Incentives/ERC20VariableCriteriaIncentive.d.ts.map +1 -1
  90. package/dist/Incentives/ERC20VariableCriteriaIncentive.js +112 -80
  91. package/dist/Incentives/ERC20VariableCriteriaIncentive.js.map +1 -1
  92. package/dist/Incentives/ERC20VariableCriteriaIncentiveV2.cjs +2 -0
  93. package/dist/Incentives/ERC20VariableCriteriaIncentiveV2.cjs.map +1 -0
  94. package/dist/Incentives/ERC20VariableCriteriaIncentiveV2.d.ts +903 -0
  95. package/dist/Incentives/ERC20VariableCriteriaIncentiveV2.d.ts.map +1 -0
  96. package/dist/Incentives/ERC20VariableCriteriaIncentiveV2.js +242 -0
  97. package/dist/Incentives/ERC20VariableCriteriaIncentiveV2.js.map +1 -0
  98. package/dist/Incentives/ERC20VariableIncentive.cjs +1 -1
  99. package/dist/Incentives/ERC20VariableIncentive.cjs.map +1 -1
  100. package/dist/Incentives/ERC20VariableIncentive.d.ts +3 -3
  101. package/dist/Incentives/ERC20VariableIncentive.d.ts.map +1 -1
  102. package/dist/Incentives/ERC20VariableIncentive.js +22 -22
  103. package/dist/Incentives/ERC20VariableIncentive.js.map +1 -1
  104. package/dist/Incentives/Incentive.cjs +1 -1
  105. package/dist/Incentives/Incentive.d.ts +8 -6
  106. package/dist/Incentives/Incentive.d.ts.map +1 -1
  107. package/dist/Incentives/Incentive.js +19 -14
  108. package/dist/Incentives/Incentive.js.map +1 -1
  109. package/dist/Incentives/PointsIncentive.cjs +1 -1
  110. package/dist/Incentives/PointsIncentive.cjs.map +1 -1
  111. package/dist/Incentives/PointsIncentive.js +9 -9
  112. package/dist/Incentives/PointsIncentive.js.map +1 -1
  113. package/dist/SimpleDenyList-B_AcmgYq.cjs +2 -0
  114. package/dist/{SimpleDenyList-DgjVf7FK.cjs.map → SimpleDenyList-B_AcmgYq.cjs.map} +1 -1
  115. package/dist/SimpleDenyList-BbDLzRw7.js +133 -0
  116. package/dist/{SimpleDenyList-BKfPoTo1.js.map → SimpleDenyList-BbDLzRw7.js.map} +1 -1
  117. package/dist/Validators/LimitedSignerValidator.cjs +1 -1
  118. package/dist/Validators/LimitedSignerValidator.cjs.map +1 -1
  119. package/dist/Validators/LimitedSignerValidator.js +13 -13
  120. package/dist/Validators/LimitedSignerValidator.js.map +1 -1
  121. package/dist/Validators/SignerValidator.cjs +1 -1
  122. package/dist/Validators/SignerValidator.cjs.map +1 -1
  123. package/dist/Validators/SignerValidator.js +52 -52
  124. package/dist/Validators/SignerValidator.js.map +1 -1
  125. package/dist/Validators/Validator.cjs +1 -1
  126. package/dist/Validators/Validator.js +2 -2
  127. package/dist/componentInterfaces-C5ig8mCK.cjs +2 -0
  128. package/dist/componentInterfaces-C5ig8mCK.cjs.map +1 -0
  129. package/dist/componentInterfaces-Ddus5rIA.js +23 -0
  130. package/dist/componentInterfaces-Ddus5rIA.js.map +1 -0
  131. package/dist/deployments-C17nvui-.cjs +2 -0
  132. package/dist/deployments-C17nvui-.cjs.map +1 -0
  133. package/dist/deployments-CH4Xmkbv.js +132 -0
  134. package/dist/{deployments-W_LUj833.js.map → deployments-CH4Xmkbv.js.map} +1 -1
  135. package/dist/deployments.json +63 -48
  136. package/dist/{generated-CElkFqkY.js → generated-CINzoGbl.js} +2611 -955
  137. package/dist/generated-CINzoGbl.js.map +1 -0
  138. package/dist/generated-C_JEoLDO.cjs +3 -0
  139. package/dist/generated-C_JEoLDO.cjs.map +1 -0
  140. package/dist/index.cjs +1 -1
  141. package/dist/index.d.ts +3 -0
  142. package/dist/index.d.ts.map +1 -1
  143. package/dist/index.js +167 -154
  144. package/dist/index.js.map +1 -1
  145. package/dist/utils.cjs.map +1 -1
  146. package/dist/utils.js.map +1 -1
  147. package/package.json +20 -2
  148. package/src/Actions/EventAction.ts +11 -0
  149. package/src/BoostCore.test.ts +14 -9
  150. package/src/BoostCore.ts +428 -26
  151. package/src/Budgets/Budget.ts +8 -1
  152. package/src/Budgets/TransparentBudget.test.ts +70 -0
  153. package/src/Budgets/TransparentBudget.ts +334 -0
  154. package/src/Deployable/Deployable.ts +1 -1
  155. package/src/Incentives/ERC20PeggedIncentive.ts +1 -1
  156. package/src/Incentives/ERC20PeggedVariableCriteriaIncentive.ts +3 -1
  157. package/src/Incentives/{ERC20PeggedVariableCriteriaIncentive.test.ts → ERC20PeggedVariableCriteriaIncentiveV2.test.ts} +20 -16
  158. package/src/Incentives/ERC20PeggedVariableCriteriaIncentiveV2.ts +872 -0
  159. package/src/Incentives/ERC20VariableCriteriaIncentive.ts +50 -1
  160. package/src/Incentives/{ERC20VariableCriteriaIncentive.test.ts → ERC20VariableCriteriaIncentiveV2.test.ts} +24 -19
  161. package/src/Incentives/ERC20VariableCriteriaIncentiveV2.ts +447 -0
  162. package/src/Incentives/ERC20VariableIncentive.ts +4 -2
  163. package/src/Incentives/Incentive.ts +13 -2
  164. package/src/index.test.ts +2 -2
  165. package/src/index.ts +3 -0
  166. package/src/utils.ts +1 -1
  167. package/dist/Budget-BjfL8dVX.cjs +0 -2
  168. package/dist/Budget-BjfL8dVX.cjs.map +0 -1
  169. package/dist/Budget-DD7IPuDx.js +0 -922
  170. package/dist/Budget-DD7IPuDx.js.map +0 -1
  171. package/dist/Incentive-V1RjH38L.js +0 -1036
  172. package/dist/Incentive-V1RjH38L.js.map +0 -1
  173. package/dist/Incentive-gVTfsnMB.cjs +0 -2
  174. package/dist/Incentive-gVTfsnMB.cjs.map +0 -1
  175. package/dist/SimpleDenyList-BKfPoTo1.js +0 -133
  176. package/dist/SimpleDenyList-DgjVf7FK.cjs +0 -2
  177. package/dist/componentInterfaces-CA1UIqWL.js +0 -20
  178. package/dist/componentInterfaces-CA1UIqWL.js.map +0 -1
  179. package/dist/componentInterfaces-aBgBbB7r.cjs +0 -2
  180. package/dist/componentInterfaces-aBgBbB7r.cjs.map +0 -1
  181. package/dist/deployments-CwTZr-cK.cjs +0 -2
  182. package/dist/deployments-CwTZr-cK.cjs.map +0 -1
  183. package/dist/deployments-W_LUj833.js +0 -117
  184. package/dist/generated-BPiHi7W2.cjs +0 -3
  185. package/dist/generated-BPiHi7W2.cjs.map +0 -1
  186. package/dist/generated-CElkFqkY.js.map +0 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@boostxyz/sdk",
3
- "version": "6.1.3",
3
+ "version": "7.0.0-canary.1",
4
4
  "license": "GPL-3.0-or-later",
5
5
  "type": "module",
6
6
  "files": [
@@ -181,6 +181,24 @@
181
181
  "node": "./dist/Incentives/ERC20VariableCriteriaIncentive.js",
182
182
  "types": "./dist/Incentives/ERC20VariableCriteriaIncentive.d.ts"
183
183
  },
184
+ "./Incentives/ERC20VariableCriteriaIncentiveV2": {
185
+ "require": "./dist/Incentives/ERC20VariableCriteriaIncentiveV2.cjs",
186
+ "import": "./dist/Incentives/ERC20VariableCriteriaIncentiveV2.js",
187
+ "node": "./dist/Incentives/ERC20VariableCriteriaIncentiveV2.js",
188
+ "types": "./dist/Incentives/ERC20VariableCriteriaIncentiveV2.d.ts"
189
+ },
190
+ "./Incentives/ERC20PeggedVariableCriteriaIncentive": {
191
+ "require": "./dist/Incentives/ERC20PeggedVariableCriteriaIncentive.cjs",
192
+ "import": "./dist/Incentives/ERC20PeggedVariableCriteriaIncentive.js",
193
+ "node": "./dist/Incentives/ERC20PeggedVariableCriteriaIncentive.js",
194
+ "types": "./dist/Incentives/ERC20PeggedVariableCriteriaIncentive.d.ts"
195
+ },
196
+ "./Incentives/ERC20PeggedVariableCriteriaIncentiveV2": {
197
+ "require": "./dist/Incentives/ERC20PeggedVariableCriteriaIncentiveV2.cjs",
198
+ "import": "./dist/Incentives/ERC20PeggedVariableCriteriaIncentiveV2.js",
199
+ "node": "./dist/Incentives/ERC20PeggedVariableCriteriaIncentiveV2.js",
200
+ "types": "./dist/Incentives/ERC20PeggedVariableCriteriaIncentiveV2.d.ts"
201
+ },
184
202
  "./Incentives/Incentive": {
185
203
  "require": "./dist/Incentives/Incentive.cjs",
186
204
  "import": "./dist/Incentives/Incentive.js",
@@ -221,7 +239,7 @@
221
239
  "viem": "2.x"
222
240
  },
223
241
  "scripts": {
224
- "build": "mkdir -p dist && vite build && tsc -p ./tsconfig.build.json --emitDeclarationOnly --declaration --declarationMap",
242
+ "build": "mkdir -p dist && vite build && npx tsc -p ./tsconfig.build.json --emitDeclarationOnly --declaration --declarationMap",
225
243
  "typecheck": "tsc -p ./tsconfig.build.json --noEmit",
226
244
  "lint:ci": "npx biome ci",
227
245
  "lint": "npx biome check",
@@ -146,6 +146,17 @@ export enum SignatureType {
146
146
  FUNC = 1,
147
147
  }
148
148
 
149
+ /**
150
+ * The type of value used for the scalar value (RAW or WAD).
151
+ *
152
+ * @export
153
+ * @enum {number}
154
+ */
155
+ export enum ValueType {
156
+ RAW = 0,
157
+ WAD = 1,
158
+ }
159
+
149
160
  /**
150
161
  * The payload describing how claimants are identified
151
162
  *
@@ -20,7 +20,8 @@ import { bytes4 } from "./utils";
20
20
  import { BoostValidatorEOA } from './Validators/Validator';
21
21
  import { AssetType } from "./transfers";
22
22
  import { waitForTransactionReceipt } from "@wagmi/core";
23
- import { SignatureType } from "./Actions/EventAction";
23
+ import { SignatureType, ValueType } from "./Actions/EventAction";
24
+ import { MockERC721 } from "@boostxyz/test/MockERC721";
24
25
 
25
26
  let fixtures: Fixtures, budgets: BudgetFixtures;
26
27
 
@@ -958,12 +959,12 @@ describe("BoostCore", () => {
958
959
  test("can create a boost with a pegged variable criteria incentive", async () => {
959
960
  const { core } = fixtures;
960
961
  const { budget, erc20 } = budgets;
961
-
962
+
962
963
  // Create a new MockERC721 instance
963
964
  const erc721 = await loadFixture(fundErc721(defaultOptions));
964
965
 
965
966
  // Create the pegged variable criteria incentive
966
- const peggedVariableCriteriaIncentive = core.ERC20PeggedVariableCriteriaIncentive({
967
+ const peggedVariableCriteriaIncentive = core.ERC20PeggedVariableCriteriaIncentiveV2({
967
968
  asset: erc20.assertValidAddress(),
968
969
  peg: erc20.assertValidAddress(), // Using same token as peg for simplicity
969
970
  reward: parseEther("1"),
@@ -975,6 +976,7 @@ describe("BoostCore", () => {
975
976
  signature: pad(bytes4("transferFrom(address,address,uint256)")),
976
977
  fieldIndex: 2,
977
978
  targetContract: erc721.assertValidAddress(),
979
+ valueType: ValueType.WAD,
978
980
  },
979
981
  });
980
982
 
@@ -1021,6 +1023,7 @@ describe("BoostCore", () => {
1021
1023
  expect(criteria.targetContract.toLowerCase()).toBe(
1022
1024
  erc721.address?.toLowerCase(),
1023
1025
  );
1026
+ expect(criteria.valueType).toBe(ValueType.WAD);
1024
1027
  });
1025
1028
  });
1026
1029
 
@@ -1046,7 +1049,7 @@ describe("Top-Up Incentives", () => {
1046
1049
  asset: erc20.assertValidAddress(),
1047
1050
  target: defaultOptions.account.address,
1048
1051
  });
1049
-
1052
+
1050
1053
 
1051
1054
  const createdBoost = await core.createBoost({
1052
1055
  protocolFee: 0n,
@@ -1147,9 +1150,9 @@ describe("Top-Up Incentives", () => {
1147
1150
  });
1148
1151
 
1149
1152
  describe("ERC20PeggedVariableCriteriaIncentive Top-Ups", () => {
1150
- let incentive: ReturnType<typeof fixtures.core.ERC20PeggedVariableCriteriaIncentive>;
1153
+ let incentive: ReturnType<typeof fixtures.core.ERC20PeggedVariableCriteriaIncentiveV2>;
1151
1154
  let boostId: bigint;
1152
- let erc721: ReturnType<typeof fundErc721>;
1155
+ let erc721: MockERC721;
1153
1156
 
1154
1157
  beforeAll(async () => {
1155
1158
  const { core } = fixtures;
@@ -1158,7 +1161,7 @@ describe("ERC20PeggedVariableCriteriaIncentive Top-Ups", () => {
1158
1161
  // Create a new MockERC721 instance
1159
1162
  erc721 = await loadFixture(fundErc721(defaultOptions));
1160
1163
 
1161
- incentive = core.ERC20PeggedVariableCriteriaIncentive({
1164
+ incentive = core.ERC20PeggedVariableCriteriaIncentiveV2({
1162
1165
  asset: erc20.assertValidAddress(),
1163
1166
  peg: erc20.assertValidAddress(),
1164
1167
  reward: parseEther("1"),
@@ -1170,6 +1173,7 @@ describe("ERC20PeggedVariableCriteriaIncentive Top-Ups", () => {
1170
1173
  signature: pad(bytes4("transferFrom(address,address,uint256)")),
1171
1174
  fieldIndex: 2,
1172
1175
  targetContract: erc721.assertValidAddress(),
1176
+ valueType: ValueType.WAD,
1173
1177
  },
1174
1178
  });
1175
1179
 
@@ -1288,11 +1292,11 @@ describe("ERC20PeggedVariableCriteriaIncentive with LimitedSignerValidator", ()
1288
1292
  const { budget, erc20 } = budgets;
1289
1293
 
1290
1294
  const erc721 = await loadFixture(fundErc721(defaultOptions));
1291
- const incentive = core.ERC20PeggedVariableCriteriaIncentive({
1295
+ const incentive = core.ERC20PeggedVariableCriteriaIncentiveV2({
1292
1296
  asset: erc20.assertValidAddress(),
1293
1297
  peg: erc20.assertValidAddress(),
1294
1298
  reward: parseEther("1"),
1295
- limit: parseEther("10"),
1299
+ limit: parseEther("10"),
1296
1300
  maxReward: parseEther("2"),
1297
1301
  manager: budget.assertValidAddress(),
1298
1302
  criteria: {
@@ -1300,6 +1304,7 @@ describe("ERC20PeggedVariableCriteriaIncentive with LimitedSignerValidator", ()
1300
1304
  signature: pad(bytes4("transferFrom(address,address,uint256)")),
1301
1305
  fieldIndex: 2,
1302
1306
  targetContract: erc721.assertValidAddress(),
1307
+ valueType: ValueType.WAD,
1303
1308
  },
1304
1309
  });
1305
1310
  await erc20.mint(defaultOptions.account.address, parseEther("110"));