Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add TSDoc comments to SpokePool ABI with scope reduction warning #114

Merged
merged 2 commits into from
Dec 18, 2024
Merged

docs: add TSDoc comments to SpokePool ABI with scope reduction warning #114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
301cc57
docs: add TSDoc comments to SpokePool ABI with scope reduction warning
james-a-morris Dec 16, 2024
3a74ee6
add changeset
gsteenkamp89 Dec 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/great-avocados-impress.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@across-protocol/app-sdk": patch
---

add TSDoc comments to SpokePool ABI with scope reduction warning
6 changes: 5 additions & 1 deletion packages/sdk/src/abis/SpokePool.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// TODO: remove what we don't use
/**
* @notice ABI definition for the Across Protocol SpokePool contract
* @dev WARNING: This ABI may be reduced in scope over time as unused functions are removed
* @see {@link https://github.com/across-protocol/contracts/blob/audit-latest/contracts/SpokePool.sol} for the most recent audited contract specification
*/
export const spokePoolAbi = [
{ inputs: [], name: "DepositsArePaused", type: "error" },
{ inputs: [], name: "DisabledRoute", type: "error" },
Expand Down
Loading