From 301cc570d4def3decf858da5ccdab1a99f5ff2d6 Mon Sep 17 00:00:00 2001 From: james-a-morris Date: Mon, 16 Dec 2024 15:48:02 -0500 Subject: [PATCH 1/2] docs: add TSDoc comments to SpokePool ABI with scope reduction warning - Add warning about potential future ABI scope reduction - Include reference to audited contract specification - Link to latest audited SpokePool contract on GitHub Signed-off-by: james-a-morris --- packages/sdk/src/abis/SpokePool.ts | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/packages/sdk/src/abis/SpokePool.ts b/packages/sdk/src/abis/SpokePool.ts index e9c7cbe..29643f1 100644 --- a/packages/sdk/src/abis/SpokePool.ts +++ b/packages/sdk/src/abis/SpokePool.ts @@ -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" }, From 3a74ee6fe18c2e56cab698630e6ed4ed48360f42 Mon Sep 17 00:00:00 2001 From: Gerhard Steenkamp Date: Wed, 18 Dec 2024 13:19:35 +0200 Subject: [PATCH 2/2] add changeset --- .changeset/great-avocados-impress.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/great-avocados-impress.md diff --git a/.changeset/great-avocados-impress.md b/.changeset/great-avocados-impress.md new file mode 100644 index 0000000..12a0d8e --- /dev/null +++ b/.changeset/great-avocados-impress.md @@ -0,0 +1,5 @@ +--- +"@across-protocol/app-sdk": patch +--- + +add TSDoc comments to SpokePool ABI with scope reduction warning