feat: bump dojo v1.0.9 #363
Conversation
WalkthroughThis pull request encompasses multiple minor updates across various files in the project. The changes include updating Changes
Sequence DiagramsequenceDiagram
participant Client
participant SDK
participant TokenBalanceService
Client->>SDK: onTokenBalanceUpdated(contracts, accounts, callback)
SDK->>TokenBalanceService: Create Subscription
TokenBalanceService-->>SDK: Return Subscription
SDK-->>Client: Return Subscription Object
Client->>SDK: updateTokenBalanceSubscription(subscription, newContracts, newAccounts)
SDK->>TokenBalanceService: Update Subscription
TokenBalanceService-->>SDK: Confirm Update
SDK-->>Client: Resolve Promise
Poem
Tip CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
package.json (1)
The PR title mentions version 1.0.9 but the codebase shows version 1.0.6
Based on the search results:
- All dojo packages are currently at version
1.0.6as shown in their package.json files- The latest version in the CHANGELOG.md files is also
1.0.6(released on 2024-12-23)- The PR title mentions bumping to version
1.0.9but no such version update is implemented in the codebaseThe version bump to 1.0.9 appears to be missing from this PR. The version should be updated in:
- The root lerna.json file (currently at 1.0.6)
- All package.json files in the packages directory
🔗 Analysis chain
Line range hint
1-28: Verify the dojo version bump implementation.The PR title mentions "feat: bump dojo v1.0.9" but the version update is not visible in this file.
Let's verify where the version bump is implemented:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Find files containing version information for dojo # Search for package.json files in the packages directory echo "Searching for package.json files in packages directory..." fd --type f "package.json" packages/ --exec cat {} \; | jq -c '. | select(.name | contains("dojo")) | {name: .name, version: .version}' # Search for version strings matching 1.0.9 echo "Searching for version strings..." rg -g '!node_modules' -g '!dist' "1.0.9"Length of output: 52126
Script:
#!/bin/bash # Description: Find version information in packages and version bump commits # Search for version information in package.json files echo "Searching for version information in package.json files..." fd --type f "package.json" packages/ --exec cat {} \; | jq -c '. | select(.version) | {name: .name, version: .version}' # Search for version bump commits echo "Searching for version bump commits..." git log --oneline -n 10 | grep -i "bump" # Search for version strings in other files echo "Searching for version strings in other files..." rg -g '!node_modules' -g '!dist' -g '!package.json' -g '!package-lock.json' -g '!pnpm-lock.yaml' "1\.0\.[0-9]+"Length of output: 13701
🧹 Nitpick comments (6)
examples/example-vite-svelte-recs/README.md (1)
17-18: LGTM! Consider a minor grammatical improvement.The technical considerations provide valuable context for users choosing between this template and SvelteKit. Consider adding a comma for improved readability.
- It brings its own routing solution which might not be preferable for some users. + It brings its own routing solution, which might not be preferable for some users.🧰 Tools
🪛 LanguageTool
[uncategorized] ~17-~17: Possible missing comma found.
Context: ...elteKit?** - It brings its own routing solution which might not be preferable for some ...(AI_HYDRA_LEO_MISSING_COMMA)
package.json (1)
7-8: LGTM! Consider maintaining consistency across all scripts.The switch from
npxtopnpxfor Prettier commands is appropriate since the project uses pnpm. However, the "release" script still usesnpxfor lerna. Consider updating all scripts to consistently usepnpx.Apply this diff for consistency:
- "release": "pnpm build && pnpm prettier && npx lerna publish --no-private --force-publish", + "release": "pnpm build && pnpm prettier && pnpx lerna publish --no-private --force-publish",packages/sdk/src/index.ts (2)
203-213: Correct the doc block parameters and fix the callback’s type reference.There's a minor spelling issue in the JSDoc (
Funtioninstead ofFunction). Also, static analysis suggests avoiding theFunctiontype. It's more robust to define a parameter type that accurately describes the callback's signature, preventing potential type-related bugs.Possible fix:
- * @param {Funtion} callback - JavaScript function to call on updates + * @param {(update: any) => void} callback - JavaScript function to call on updates
214-224: Recommend using more explicit callback typing instead ofFunction.Same rationale as above. For example, if the callback receives a token balance update payload, define a type or interface for that payload to ensure better type safety and clarity.
Example fix:
- callback: Function + callback: (update: any) => void🧰 Tools
🪛 Biome (1.9.4)
[error] 217-217: Don't use 'Function' as a type.
Prefer explicitly define the function shape. This type accepts any function-like value, which can be a common source of bugs.
(lint/complexity/noBannedTypes)
packages/sdk/src/types.ts (1)
340-340: Avoid usingFunctionas a type.Static analysis flags the usage of the
Functiontype. Defining a more specific function signature, if possible, is preferred. As an improvement, explicitly specify the parameter taken by the callback function to ensure clarity and type safety.Example fix:
- callback: Function + callback: (update: any) => void🧰 Tools
🪛 Biome (1.9.4)
[error] 340-340: Don't use 'Function' as a type.
Prefer explicitly define the function shape. This type accepts any function-like value, which can be a common source of bugs.
(lint/complexity/noBannedTypes)
packages/create-burner/readme.md (1)
45-49: Indent bullet points to comply with markdown lint rules.Markdownlint warns about inconsistent indentation for bullet points. Conforming to two spaces might improve readability. Consider applying the following diff:
- - [With React](#with-react) - - [Vanilla JavaScript](#vanilla-javascript) + - [With React](#with-react) + - [Vanilla JavaScript](#vanilla-javascript) - - `get(address: string)`: Get a burner account based on its address. - - `list()`: List all burners. - - `select(address: string)`: Set a burner as the active account. - - `create()`: Create a new burner. - - `account`: The active burner account. - - `isDeploying`: A boolean that indicates whether a burner is being deployed. - - `listConnectors()`: List all available connectors that can be used with Starknet React. + - `get(address: string)`: Get a burner account based on its address. + - `list()`: List all burners. + - `select(address: string)`: Set a burner as the active account. + - `create()`: Create a new burner. + - `account`: The active burner account. + - `isDeploying`: A boolean that indicates whether a burner is being deployed. + - `listConnectors()`: List all available connectors that can be used with Starknet React.Also applies to: 93-111
🧰 Tools
🪛 Markdownlint (0.37.0)
45-45: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
46-46: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
.gitignore(1 hunks)examples/example-nodejs-bot/README.md(1 hunks)examples/example-vite-kitchen-sink/README.md(1 hunks)examples/example-vite-react-sdk/README.md(2 hunks)examples/example-vite-svelte-recs/README.md(1 hunks)package.json(1 hunks)packages/create-burner/readme.md(3 hunks)packages/sdk/src/index.ts(1 hunks)packages/sdk/src/types.ts(1 hunks)
✅ Files skipped from review due to trivial changes (4)
- .gitignore
- examples/example-nodejs-bot/README.md
- examples/example-vite-react-sdk/README.md
- examples/example-vite-kitchen-sink/README.md
🧰 Additional context used
🪛 Biome (1.9.4)
packages/sdk/src/index.ts
[error] 217-217: Don't use 'Function' as a type.
Prefer explicitly define the function shape. This type accepts any function-like value, which can be a common source of bugs.
(lint/complexity/noBannedTypes)
packages/sdk/src/types.ts
[error] 340-340: Don't use 'Function' as a type.
Prefer explicitly define the function shape. This type accepts any function-like value, which can be a common source of bugs.
(lint/complexity/noBannedTypes)
🪛 LanguageTool
examples/example-vite-svelte-recs/README.md
[uncategorized] ~17-~17: Possible missing comma found.
Context: ...elteKit?** - It brings its own routing solution which might not be preferable for some ...
(AI_HYDRA_LEO_MISSING_COMMA)
packages/create-burner/readme.md
[uncategorized] ~95-~95: Loose punctuation mark.
Context: ... and more. - get(address: string): Get a burner account based on its addre...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~96-~96: Loose punctuation mark.
Context: ...unt based on its address. - list(): List all burners. - `select(address...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~97-~97: Loose punctuation mark.
Context: ...burners. - select(address: string): Set a burner as the active account. ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~98-~98: Loose punctuation mark.
Context: ... as the active account. - create(): Create a new burner. - account: T...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~99-~99: Loose punctuation mark.
Context: ...): Create a new burner. - account: The active burner account. - isDep...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~100-~100: Loose punctuation mark.
Context: ...tive burner account. - isDeploying: A boolean that indicates whether a burn...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~101-~101: Loose punctuation mark.
Context: ...being deployed. - listConnectors(): List all available connectors that can ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~104-~104: Loose punctuation mark.
Context: ...o manage burner accounts. - init(): Initializes the manager. - `getActi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~105-~105: Loose punctuation mark.
Context: ... the manager. - getActiveAccount(): Retrieves the active burner account. ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~106-~106: Loose punctuation mark.
Context: ...er account. - get(address: string): Get a burner account based on its addre...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~107-~107: Loose punctuation mark.
Context: ...unt based on its address. - list(): List all burners. - `select(address...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~108-~108: Loose punctuation mark.
Context: ...burners. - select(address: string): Set a burner as the active account. ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~109-~109: Loose punctuation mark.
Context: ... as the active account. - create(): Create a new burner. - account: T...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~110-~110: Loose punctuation mark.
Context: ...): Create a new burner. - account: The active burner account. - isDep...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~111-~111: Loose punctuation mark.
Context: ...tive burner account. - isDeploying: A boolean that indicates whether a burn...
(UNLIKELY_OPENING_PUNCTUATION)
🪛 Markdownlint (0.37.0)
packages/create-burner/readme.md
45-45: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
46-46: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
95-95: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
96-96: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
97-97: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
98-98: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
99-99: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
100-100: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
101-101: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
104-104: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
105-105: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
106-106: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
107-107: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
108-108: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
109-109: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
110-110: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
111-111: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
🔇 Additional comments (3)
packages/sdk/src/index.ts (1)
226-248: LGTM!
The method updateTokenBalanceSubscription is well-documented, and the implementation appears correct. No additional issues detected here.
packages/sdk/src/types.ts (1)
343-359: LGTM!
The method updateTokenBalanceSubscription in the SDK interface aligns with the implementation in index.ts. No issues found here.
packages/create-burner/readme.md (1)
36-39: LGTM!
The bullet points highlighting the new features are clear. No additional concerns here.
MartianGreed
force-pushed
the
feat/bump-dojo-1.0.9
branch
from
e88f93f to
5184801
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (5)
examples/example-vite-kitchen-sink/README.md (1)
48-48: Fix typo and improve grammar in the noteThere's a typo and missing article in the note.
- you main want to update `actions` contract address + you may want to update the `actions` contract address🧰 Tools
🪛 LanguageTool
[uncategorized] ~48-~48: You might be missing the article “the” here.
Context: ...### Notes - you main want to updateactionscontract address insrc/compon...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
packages/create-burner/readme.md (2)
43-49: Consider standardizing list indentation.The nested list items use 4-space indentation. While this works, the markdown standard recommends 2-space indentation for nested lists.
- [Installation](#installation) - [Usage](#usage) - - [With React](#with-react) - - [Vanilla JavaScript](#vanilla-javascript) + - [With React](#with-react) + - [Vanilla JavaScript](#vanilla-javascript) - [API](#api) - [Contribute](#contribute) - [License](#license)🧰 Tools
🪛 Markdownlint (0.37.0)
45-45: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
46-46: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
93-111: Consider enhancing API documentation.While the API documentation is clear and well-structured, consider these improvements:
- Add return types for methods to make the API more self-documenting:
- `get(address: string)`: Get a burner account based on its address. + `get(address: string): Account`: Get a burner account based on its address. - `list()`: List all burners. + `list(): Account[]`: List all burners. - `create()`: Create a new burner. + `create(): Promise<Account>`: Create a new burner.
- Standardize the indentation to use 2 spaces for nested lists to align with markdown standards.
🧰 Tools
🪛 Markdownlint (0.37.0)
95-95: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
96-96: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
97-97: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
98-98: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
99-99: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
100-100: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
101-101: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
104-104: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
105-105: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
106-106: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
107-107: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
108-108: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
109-109: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
110-110: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
111-111: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
🪛 LanguageTool
[uncategorized] ~95-~95: Loose punctuation mark.
Context: ... and more. -get(address: string): Get a burner account based on its addre...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~96-~96: Loose punctuation mark.
Context: ...unt based on its address. -list(): List all burners. - `select(address...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~97-~97: Loose punctuation mark.
Context: ...burners. -select(address: string): Set a burner as the active account. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~98-~98: Loose punctuation mark.
Context: ... as the active account. -create(): Create a new burner. -account: T...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~99-~99: Loose punctuation mark.
Context: ...): Create a new burner. -account: The active burner account. -isDep...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~100-~100: Loose punctuation mark.
Context: ...tive burner account. -isDeploying: A boolean that indicates whether a burn...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~101-~101: Loose punctuation mark.
Context: ...being deployed. -listConnectors(): List all available connectors that can ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~104-~104: Loose punctuation mark.
Context: ...o manage burner accounts. -init(): Initializes the manager. - `getActi...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~105-~105: Loose punctuation mark.
Context: ... the manager. -getActiveAccount(): Retrieves the active burner account. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~106-~106: Loose punctuation mark.
Context: ...er account. -get(address: string): Get a burner account based on its addre...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~107-~107: Loose punctuation mark.
Context: ...unt based on its address. -list(): List all burners. - `select(address...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~108-~108: Loose punctuation mark.
Context: ...burners. -select(address: string): Set a burner as the active account. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~109-~109: Loose punctuation mark.
Context: ... as the active account. -create(): Create a new burner. -account: T...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~110-~110: Loose punctuation mark.
Context: ...): Create a new burner. -account: The active burner account. -isDep...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~111-~111: Loose punctuation mark.
Context: ...tive burner account. -isDeploying: A boolean that indicates whether a burn...(UNLIKELY_OPENING_PUNCTUATION)
packages/sdk/src/index.ts (1)
202-224: Maintain consistent documentation styleThe documentation uses Rust-style (#) for sections which is inconsistent with the rest of the codebase. Also, add the callback signature details to the documentation.
Apply this diff:
/** * Subscribes to token balance updates * - * # Parameters + * @param {string[]} contract_addresses - Array of contract addresses to filter (empty for all) + * @param {string[]} account_addresses - Array of account addresses to filter (empty for all) + * @param {(balance: torii.TokenBalance) => void} callback - Function called on balance updates * - * # Returns - * Result containing subscription handle or error + * @returns {torii.Subscription} Subscription handle for managing the subscription */🧰 Tools
🪛 Biome (1.9.4)
[error] 217-217: Don't use 'Function' as a type.
Prefer explicitly define the function shape. This type accepts any function-like value, which can be a common source of bugs.
(lint/complexity/noBannedTypes)
packages/sdk/src/types.ts (1)
325-341: Maintain consistent documentation style in interfaceUpdate the documentation to match the rest of the codebase's style and add callback signature details.
Apply this diff:
/** * Subscribes to token balance updates * - * # Parameters + * @param {string[]} contract_addresses - Array of contract addresses to filter (empty for all) + * @param {string[]} account_addresses - Array of account addresses to filter (empty for all) + * @param {(balance: torii.TokenBalance) => void} callback - Function called on balance updates * - * # Returns - * Result containing subscription handle or error + * @returns {torii.Subscription} Subscription handle for managing the subscription */🧰 Tools
🪛 Biome (1.9.4)
[error] 340-340: Don't use 'Function' as a type.
Prefer explicitly define the function shape. This type accepts any function-like value, which can be a common source of bugs.
(lint/complexity/noBannedTypes)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (10)
.gitignore(1 hunks)examples/example-nodejs-bot/README.md(1 hunks)examples/example-vite-kitchen-sink/README.md(1 hunks)examples/example-vite-react-sdk/README.md(2 hunks)examples/example-vite-svelte-recs/README.md(1 hunks)package.json(1 hunks)packages/create-burner/readme.md(3 hunks)packages/sdk/src/index.ts(1 hunks)packages/sdk/src/types.ts(1 hunks)worlds/onchain-dash(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- worlds/onchain-dash
🚧 Files skipped from review as they are similar to previous changes (5)
- examples/example-nodejs-bot/README.md
- examples/example-vite-svelte-recs/README.md
- examples/example-vite-react-sdk/README.md
- .gitignore
- package.json
🧰 Additional context used
🪛 Biome (1.9.4)
packages/sdk/src/types.ts
[error] 340-340: Don't use 'Function' as a type.
Prefer explicitly define the function shape. This type accepts any function-like value, which can be a common source of bugs.
(lint/complexity/noBannedTypes)
packages/sdk/src/index.ts
[error] 217-217: Don't use 'Function' as a type.
Prefer explicitly define the function shape. This type accepts any function-like value, which can be a common source of bugs.
(lint/complexity/noBannedTypes)
🪛 LanguageTool
examples/example-vite-kitchen-sink/README.md
[uncategorized] ~48-~48: You might be missing the article “the” here.
Context: ... ### Notes - you main want to updateactionscontract address insrc/compon...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
packages/create-burner/readme.md
[uncategorized] ~95-~95: Loose punctuation mark.
Context: ... and more. - get(address: string): Get a burner account based on its addre...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~96-~96: Loose punctuation mark.
Context: ...unt based on its address. - list(): List all burners. - `select(address...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~97-~97: Loose punctuation mark.
Context: ...burners. - select(address: string): Set a burner as the active account. ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~98-~98: Loose punctuation mark.
Context: ... as the active account. - create(): Create a new burner. - account: T...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~99-~99: Loose punctuation mark.
Context: ...): Create a new burner. - account: The active burner account. - isDep...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~100-~100: Loose punctuation mark.
Context: ...tive burner account. - isDeploying: A boolean that indicates whether a burn...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~101-~101: Loose punctuation mark.
Context: ...being deployed. - listConnectors(): List all available connectors that can ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~104-~104: Loose punctuation mark.
Context: ...o manage burner accounts. - init(): Initializes the manager. - `getActi...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~105-~105: Loose punctuation mark.
Context: ... the manager. - getActiveAccount(): Retrieves the active burner account. ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~106-~106: Loose punctuation mark.
Context: ...er account. - get(address: string): Get a burner account based on its addre...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~107-~107: Loose punctuation mark.
Context: ...unt based on its address. - list(): List all burners. - `select(address...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~108-~108: Loose punctuation mark.
Context: ...burners. - select(address: string): Set a burner as the active account. ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~109-~109: Loose punctuation mark.
Context: ... as the active account. - create(): Create a new burner. - account: T...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~110-~110: Loose punctuation mark.
Context: ...): Create a new burner. - account: The active burner account. - isDep...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~111-~111: Loose punctuation mark.
Context: ...tive burner account. - isDeploying: A boolean that indicates whether a burn...
(UNLIKELY_OPENING_PUNCTUATION)
🪛 Markdownlint (0.37.0)
packages/create-burner/readme.md
45-45: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
46-46: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
95-95: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
96-96: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
97-97: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
98-98: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
99-99: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
100-100: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
101-101: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
104-104: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
105-105: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
106-106: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
107-107: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
108-108: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
109-109: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
110-110: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
111-111: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
🔇 Additional comments (4)
packages/create-burner/readme.md (2)
36-39: LGTM! Clear and well-formatted feature list.
The feature list is now more readable with each item on its own line.
61-61: LGTM! Valid example reference.
The example link is properly formatted and points to a relevant repository.
packages/sdk/src/index.ts (1)
238-248: Implementation looks good
The implementation correctly delegates to the client methods and maintains proper parameter ordering.
packages/sdk/src/types.ts (1)
355-359: Interface definition looks good
The method signatures are correctly defined and aligned with the implementation.
| onTokenBalanceUpdated: ( | ||
| contract_addresses: string[], | ||
| account_addresses: string[], | ||
| callback: Function | ||
| ): torii.Subscription => { | ||
| return client.onTokenBalanceUpdated( | ||
| contract_addresses, | ||
| account_addresses, | ||
| callback | ||
| ); | ||
| }, |
There was a problem hiding this comment.
Improve type safety of the callback parameter
The Function type is too broad and can lead to runtime errors. Define a specific callback signature for better type safety.
Apply this diff:
-callback: Function
+callback: (balance: torii.TokenBalance) => void📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| onTokenBalanceUpdated: ( | |
| contract_addresses: string[], | |
| account_addresses: string[], | |
| callback: Function | |
| ): torii.Subscription => { | |
| return client.onTokenBalanceUpdated( | |
| contract_addresses, | |
| account_addresses, | |
| callback | |
| ); | |
| }, | |
| onTokenBalanceUpdated: ( | |
| contract_addresses: string[], | |
| account_addresses: string[], | |
| callback: (balance: torii.TokenBalance) => void | |
| ): torii.Subscription => { | |
| return client.onTokenBalanceUpdated( | |
| contract_addresses, | |
| account_addresses, | |
| callback | |
| ); | |
| }, |
🧰 Tools
🪛 Biome (1.9.4)
[error] 217-217: Don't use 'Function' as a type.
Prefer explicitly define the function shape. This type accepts any function-like value, which can be a common source of bugs.
(lint/complexity/noBannedTypes)
| onTokenBalanceUpdated: ( | ||
| contract_addresses: string[], | ||
| account_addresses: string[], | ||
| callback: Function | ||
| ) => torii.Subscription; |
There was a problem hiding this comment.
Improve type safety of the callback parameter in interface
The Function type should be replaced with a specific callback signature for better type safety, matching the implementation.
Apply this diff:
-callback: Function
+callback: (balance: torii.TokenBalance) => void📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| onTokenBalanceUpdated: ( | |
| contract_addresses: string[], | |
| account_addresses: string[], | |
| callback: Function | |
| ) => torii.Subscription; | |
| onTokenBalanceUpdated: ( | |
| contract_addresses: string[], | |
| account_addresses: string[], | |
| callback: (balance: torii.TokenBalance) => void | |
| ) => torii.Subscription; |
🧰 Tools
🪛 Biome (1.9.4)
[error] 340-340: Don't use 'Function' as a type.
Prefer explicitly define the function shape. This type accepts any function-like value, which can be a common source of bugs.
(lint/complexity/noBannedTypes)
MartianGreed
force-pushed
the
feat/bump-dojo-1.0.9
branch
from
5184801 to
32db06c
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
packages/sdk/src/types.ts (1)
337-341:⚠️ Potential issueImprove type safety of the callback parameter
The
Functiontype should be replaced with a specific callback signature for better type safety, matching the implementation.Apply this diff:
-callback: Function +callback: (balance: torii.TokenBalance) => void🧰 Tools
🪛 Biome (1.9.4)
[error] 340-340: Don't use 'Function' as a type.
Prefer explicitly define the function shape. This type accepts any function-like value, which can be a common source of bugs.
(lint/complexity/noBannedTypes)
🧹 Nitpick comments (7)
examples/example-vite-kitchen-sink/README.md (1)
48-48: Fix typo in READMEThe phrase "you main want" appears to contain a typo.
-you main want to update `actions` contract address +you may want to update the `actions` contract address🧰 Tools
🪛 LanguageTool
[uncategorized] ~48-~48: You might be missing the article “the” here.
Context: ...### Notes - you main want to updateactionscontract address insrc/compon...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
packages/sdk/src/index.ts (1)
238-248: Add error handling for async operationThe async method should include error handling to gracefully handle potential failures when updating the subscription.
updateTokenBalanceSubscription: async ( subscription: torii.Subscription, contract_addresses: string[], account_addresses: string[] ): Promise<void> => { + try { return await client.updateTokenBalanceSubscription( subscription, contract_addresses, account_addresses ); + } catch (error) { + console.error("Failed to update token balance subscription:", error); + throw error; + } },packages/create-burner/readme.md (5)
36-39: Adjust list indentation for consistency.The features are well-structured and clearly communicate the package's capabilities. However, to maintain consistency with markdown standards, adjust the list indentation from 4 spaces to 2 spaces.
- - Initialize and manage burner accounts. - - Abstracts away intricacies related to creating, fetching, and setting active burner accounts. - - Easily integrate with React apps using the provided hook. - - Vanilla JS support. + - Initialize and manage burner accounts. + - Abstracts away intricacies related to creating, fetching, and setting active burner accounts. + - Easily integrate with React apps using the provided hook. + - Vanilla JS support.
43-49: Standardize TOC indentation.The Table of Contents structure is clear, but the indentation should be adjusted for consistency with markdown standards.
- - [With React](#with-react) - - [Vanilla JavaScript](#vanilla-javascript) + - [With React](#with-react) + - [Vanilla JavaScript](#vanilla-javascript)🧰 Tools
🪛 Markdownlint (0.37.0)
45-45: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
46-46: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
61-61: Consider expanding "In the wild" examples.While the dojo-starter-react-app is a good reference, consider adding more real-world examples to showcase broader adoption and different use cases of the package.
93-111: Enhance API documentation.The API documentation is comprehensive but could be improved in several ways:
- Fix indentation to use 2 spaces instead of 4 for consistency with markdown standards.
- Consider adding example usage for each method.
- Provide more detailed descriptions for methods like
listConnectors().Example enhancement for the
listConnectors()method:- `listConnectors()`: List all available connectors that can be used with Starknet React. Example: ```typescript const { listConnectors } = useBurner(); const connectors = listConnectors(); // connectors = [{ id: 'burner', name: 'Burner Account' }, ...]<details> <summary>🧰 Tools</summary> <details> <summary>🪛 Markdownlint (0.37.0)</summary> 95-95: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 96-96: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 97-97: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 98-98: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 99-99: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 100-100: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 101-101: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 104-104: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 105-105: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 106-106: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 107-107: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 108-108: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 109-109: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 110-110: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 111-111: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) </details> <details> <summary>🪛 LanguageTool</summary> [uncategorized] ~95-~95: Loose punctuation mark. Context: ... and more. - `get(address: string)`: Get a burner account based on its addre... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~96-~96: Loose punctuation mark. Context: ...unt based on its address. - `list()`: List all burners. - `select(address... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~97-~97: Loose punctuation mark. Context: ...burners. - `select(address: string)`: Set a burner as the active account. ... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~98-~98: Loose punctuation mark. Context: ... as the active account. - `create()`: Create a new burner. - `account`: T... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~99-~99: Loose punctuation mark. Context: ...)`: Create a new burner. - `account`: The active burner account. - `isDep... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~100-~100: Loose punctuation mark. Context: ...tive burner account. - `isDeploying`: A boolean that indicates whether a burn... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~101-~101: Loose punctuation mark. Context: ...being deployed. - `listConnectors()`: List all available connectors that can ... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~104-~104: Loose punctuation mark. Context: ...o manage burner accounts. - `init()`: Initializes the manager. - `getActi... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~105-~105: Loose punctuation mark. Context: ... the manager. - `getActiveAccount()`: Retrieves the active burner account. ... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~106-~106: Loose punctuation mark. Context: ...er account. - `get(address: string)`: Get a burner account based on its addre... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~107-~107: Loose punctuation mark. Context: ...unt based on its address. - `list()`: List all burners. - `select(address... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~108-~108: Loose punctuation mark. Context: ...burners. - `select(address: string)`: Set a burner as the active account. ... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~109-~109: Loose punctuation mark. Context: ... as the active account. - `create()`: Create a new burner. - `account`: T... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~110-~110: Loose punctuation mark. Context: ...)`: Create a new burner. - `account`: The active burner account. - `isDep... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~111-~111: Loose punctuation mark. Context: ...tive burner account. - `isDeploying`: A boolean that indicates whether a burn... (UNLIKELY_OPENING_PUNCTUATION) </details> </details> --- Line range hint `1-111`: **Overall documentation assessment.** The documentation provides a clear and comprehensive overview of the package. However, consider: 1. Applying consistent 2-space indentation throughout all lists 2. Adding more real-world examples in the "In the wild" section 3. Enhancing API documentation with usage examples 4. Adding a "Getting Started" section with a complete example Would you like me to help create a "Getting Started" section with a complete example that demonstrates the typical usage flow? <details> <summary>🧰 Tools</summary> <details> <summary>🪛 Markdownlint (0.37.0)</summary> 95-95: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 96-96: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 97-97: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 98-98: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 99-99: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 100-100: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 101-101: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 104-104: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 105-105: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 106-106: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 107-107: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 108-108: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 109-109: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 110-110: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 111-111: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) </details> <details> <summary>🪛 LanguageTool</summary> [uncategorized] ~95-~95: Loose punctuation mark. Context: ... and more. - `get(address: string)`: Get a burner account based on its addre... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~96-~96: Loose punctuation mark. Context: ...unt based on its address. - `list()`: List all burners. - `select(address... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~97-~97: Loose punctuation mark. Context: ...burners. - `select(address: string)`: Set a burner as the active account. ... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~98-~98: Loose punctuation mark. Context: ... as the active account. - `create()`: Create a new burner. - `account`: T... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~99-~99: Loose punctuation mark. Context: ...)`: Create a new burner. - `account`: The active burner account. - `isDep... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~100-~100: Loose punctuation mark. Context: ...tive burner account. - `isDeploying`: A boolean that indicates whether a burn... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~101-~101: Loose punctuation mark. Context: ...being deployed. - `listConnectors()`: List all available connectors that can ... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~104-~104: Loose punctuation mark. Context: ...o manage burner accounts. - `init()`: Initializes the manager. - `getActi... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~105-~105: Loose punctuation mark. Context: ... the manager. - `getActiveAccount()`: Retrieves the active burner account. ... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~106-~106: Loose punctuation mark. Context: ...er account. - `get(address: string)`: Get a burner account based on its addre... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~107-~107: Loose punctuation mark. Context: ...unt based on its address. - `list()`: List all burners. - `select(address... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~108-~108: Loose punctuation mark. Context: ...burners. - `select(address: string)`: Set a burner as the active account. ... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~109-~109: Loose punctuation mark. Context: ... as the active account. - `create()`: Create a new burner. - `account`: T... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~110-~110: Loose punctuation mark. Context: ...)`: Create a new burner. - `account`: The active burner account. - `isDep... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~111-~111: Loose punctuation mark. Context: ...tive burner account. - `isDeploying`: A boolean that indicates whether a burn... (UNLIKELY_OPENING_PUNCTUATION) </details> </details> </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** **Plan: Pro** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 5184801dc907993d70c1260d7ddb0505bc86fcc7 and 32db06cf32348b6b2d150e86817326f9fb35ce45. </details> <details> <summary>📒 Files selected for processing (11)</summary> * `.github/workflows/ci.yaml` (1 hunks) * `.gitignore` (1 hunks) * `examples/example-nodejs-bot/README.md` (1 hunks) * `examples/example-vite-kitchen-sink/README.md` (1 hunks) * `examples/example-vite-react-sdk/README.md` (2 hunks) * `examples/example-vite-svelte-recs/README.md` (1 hunks) * `package.json` (1 hunks) * `packages/create-burner/readme.md` (3 hunks) * `packages/sdk/src/index.ts` (1 hunks) * `packages/sdk/src/types.ts` (1 hunks) * `worlds/onchain-dash` (1 hunks) </details> <details> <summary>🚧 Files skipped from review as they are similar to previous changes (6)</summary> * .gitignore * examples/example-nodejs-bot/README.md * examples/example-vite-react-sdk/README.md * worlds/onchain-dash * examples/example-vite-svelte-recs/README.md * package.json </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 Biome (1.9.4)</summary> <details> <summary>packages/sdk/src/index.ts</summary> [error] 217-217: Don't use 'Function' as a type. Prefer explicitly define the function shape. This type accepts any function-like value, which can be a common source of bugs. (lint/complexity/noBannedTypes) </details> <details> <summary>packages/sdk/src/types.ts</summary> [error] 340-340: Don't use 'Function' as a type. Prefer explicitly define the function shape. This type accepts any function-like value, which can be a common source of bugs. (lint/complexity/noBannedTypes) </details> </details> <details> <summary>🪛 LanguageTool</summary> <details> <summary>examples/example-vite-kitchen-sink/README.md</summary> [uncategorized] ~48-~48: You might be missing the article “the” here. Context: ...` ### Notes - you main want to update `actions` contract address in `src/compon... (AI_EN_LECTOR_MISSING_DETERMINER_THE) </details> <details> <summary>packages/create-burner/readme.md</summary> [uncategorized] ~95-~95: Loose punctuation mark. Context: ... and more. - `get(address: string)`: Get a burner account based on its addre... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~96-~96: Loose punctuation mark. Context: ...unt based on its address. - `list()`: List all burners. - `select(address... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~97-~97: Loose punctuation mark. Context: ...burners. - `select(address: string)`: Set a burner as the active account. ... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~98-~98: Loose punctuation mark. Context: ... as the active account. - `create()`: Create a new burner. - `account`: T... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~99-~99: Loose punctuation mark. Context: ...)`: Create a new burner. - `account`: The active burner account. - `isDep... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~100-~100: Loose punctuation mark. Context: ...tive burner account. - `isDeploying`: A boolean that indicates whether a burn... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~101-~101: Loose punctuation mark. Context: ...being deployed. - `listConnectors()`: List all available connectors that can ... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~104-~104: Loose punctuation mark. Context: ...o manage burner accounts. - `init()`: Initializes the manager. - `getActi... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~105-~105: Loose punctuation mark. Context: ... the manager. - `getActiveAccount()`: Retrieves the active burner account. ... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~106-~106: Loose punctuation mark. Context: ...er account. - `get(address: string)`: Get a burner account based on its addre... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~107-~107: Loose punctuation mark. Context: ...unt based on its address. - `list()`: List all burners. - `select(address... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~108-~108: Loose punctuation mark. Context: ...burners. - `select(address: string)`: Set a burner as the active account. ... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~109-~109: Loose punctuation mark. Context: ... as the active account. - `create()`: Create a new burner. - `account`: T... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~110-~110: Loose punctuation mark. Context: ...)`: Create a new burner. - `account`: The active burner account. - `isDep... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~111-~111: Loose punctuation mark. Context: ...tive burner account. - `isDeploying`: A boolean that indicates whether a burn... (UNLIKELY_OPENING_PUNCTUATION) </details> </details> <details> <summary>🪛 Markdownlint (0.37.0)</summary> <details> <summary>packages/create-burner/readme.md</summary> 45-45: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 46-46: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 95-95: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 96-96: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 97-97: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 98-98: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 99-99: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 100-100: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 101-101: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 104-104: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 105-105: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 106-106: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 107-107: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 108-108: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 109-109: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 110-110: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) --- 111-111: Expected: 2; Actual: 4 Unordered list indentation (MD007, ul-indent) </details> </details> </details> <details> <summary>🔇 Additional comments (3)</summary> <details> <summary>.github/workflows/ci.yaml (1)</summary> `23-23`: **LGTM! CI workflow updates are consistent** The dojo version bump and addition of onchain-dash world testing steps are well-structured and follow existing patterns. Also applies to: 28-31 </details> <details> <summary>packages/sdk/src/index.ts (1)</summary> `214-224`: **Improve type safety of the callback parameter** The `Function` type is too broad and can lead to runtime errors. This issue was previously identified and should be addressed. ```diff -callback: Function +callback: (balance: torii.TokenBalance) => void🧰 Tools
🪛 Biome (1.9.4)
[error] 217-217: Don't use 'Function' as a type.
Prefer explicitly define the function shape. This type accepts any function-like value, which can be a common source of bugs.
(lint/complexity/noBannedTypes)
packages/sdk/src/types.ts (1)
355-359: LGTM! Well-documented method with proper type safetyThe method signature and documentation are clear and complete. The types are properly defined for all parameters.
Closes #
Introduced changes
Checklist
Summary by CodeRabbit
onTokenBalanceUpdated: Subscribe to updates on token balances.updateTokenBalanceSubscription: Modify existing token balance subscriptions..gitignoreto excludelerna-debug.log.package.jsonto usepnpxinstead ofnpx.