feat(sdk): typedoc

.gitignore

@@ -9,3 +9,4 @@ tsconfig.tsbuildinfo
 .env*
 !.env.sample
 cache
+docs

package.json

@@ -37,6 +37,7 @@
     "lefthook": "^1.6.15",
     "prettier": "^3.2.5",
     "turbo": "^2.0.0",
+    "typedoc": "^0.26.4",
     "typescript": "^5.3.3",
     "viem": "^2.9.9",
     "vite": "^5.2.13",

packages/sdk/package.json

@@ -197,7 +197,8 @@
     "bench:ci": "CI=true vitest bench",
     "clean": "rm -rf dist",
     "test": "vitest dev",
-    "test:ci": "CI=true vitest --coverage"
+    "test:ci": "CI=true vitest --coverage",
+    "typedoc": "typedoc"
   },
   "devDependencies": {
     "@boostxyz/evm": "workspace:*"

packages/sdk/src/BoostCore.ts

@@ -182,7 +182,6 @@ export class BoostCore extends Deployable<[Address, Address]> {
     let budgetPayload: OnChainBoostPayload['budget'] = zeroAddress;
     if (budget.address) {
       budgetPayload = budget.address;
-      console.log(await budget.isAuthorized(coreAddress));
       if (!(await budget.isAuthorized(coreAddress))) {
         throw new BudgetMustAuthorizeBoostCore(coreAddress);
       }
@@ -286,8 +285,6 @@ export class BoostCore extends Deployable<[Address, Address]> {
       }
     }
 
-    console.log(incentivesPayloads);
-
     const onChainPayload = {
       budget: budgetPayload,
       action: actionPayload,
@@ -300,13 +297,6 @@ export class BoostCore extends Deployable<[Address, Address]> {
       owner,
     };
 
-    console.log(onChainPayload);
-
-    console.log({
-      args: [prepareBoostPayload(onChainPayload)],
-      ...this.optionallyAttachAccount(options.account),
-    });
-
     const boostHash = await boostFactory(options.config, {
       args: [prepareBoostPayload(onChainPayload)],
       ...this.optionallyAttachAccount(options.account),

packages/sdk/test/MockERC20.ts

@@ -44,7 +44,8 @@ export class MockERC20 extends Deployable {
     value: bigint,
     params?: WriteParams<typeof mockErc20Abi, 'mintPayable'>,
   ) {
-    return this.awaitResult(this.mintPayableRaw(address, value, params));
+    // biome-ignore lint/suspicious/noExplicitAny: this is a mock contract, it's fine
+    return this.awaitResult(this.mintPayableRaw(address, value, params as any));
   }
   public async mintPayableRaw(
     address: Address,

packages/sdk/typedoc.json

@@ -0,0 +1,6 @@
+{
+  // Comments are supported, like tsconfig.json
+  "entryPoints": ["./src/index.ts"],
+  "exclude": ["./test", "./src/**/*.test.ts"],
+  "out": "docs"
+}