feat(svm): include solana artifacts in package build output #806

md0x · 2024-12-18T13:30:37Z

Changes proposed in this PR:

Include Solana artifacts in the package build output.
Add utility functions to get connected Anchor program instances with types.

Signed-off-by: Pablo Maldonado <[email protected]>

linear · 2024-12-18T13:30:42Z

ACX-3481 look into typechain for svm? is there a type safe interface we can export?

Signed-off-by: Pablo Maldonado <[email protected]>

md0x · 2024-12-18T17:34:57Z

scripts/generate-svm-assets.sh

+      printf toupper(substr($i,1,1)) tolower(substr($i,2));
+    }
+  }')
+  newName="${camelCaseName}Anchor"


Prepend "Anchor" to the types to prevent conflicts with evm types

md0x · 2024-12-18T17:37:14Z

scripts/generate-svm-assets.sh

+      printf toupper(substr($i,1,1)) tolower(substr($i,2));
+    }
+  }')
+  IMPORTS="${IMPORTS}const ${camelCaseName}Idl = require(\"./${filename}\");\n"


We use require() for the IDLs similarly as before in the scripts to avoid ts issues:

contracts/scripts/svm/executeRebalanceToHubPool.ts

Line 77 in e0cc5a2

const svmSpokeIdl = require("../../target/idl/svm_spoke.json");

Signed-off-by: Pablo Maldonado <[email protected]>

md0x · 2024-12-18T18:45:25Z

index.ts

@@ -1,3 +1,4 @@
 export * from "./typechain";
 export * from "./src/DeploymentUtils";
 export * from "./utils";
+export * from "./src/svm";


The program getters, types, and IDLs can be imported directly from @across-protocol/contracts, as well as utility functions (we should move the latter to the SDK next).

md0x · 2024-12-18T19:23:57Z

src/svm/programConnectors.ts

+} from "./assets";
+
+export function getConnectedProgram<P extends Idl>(idl: P, provider: Provider) {
+  return new Program<P>(idl, provider);


Note: In the SVM scripts, we have been connecting to the program ID defined in the IDL file. Since these IDs are generated automatically, any future changes to the program, if merged into master, could cause the program ID to drift.
We should explore alternatives where the caller can pass a specific program ID in a follow-up PR so we can use this in our bots to prevent unexpected programIDs changes. Wdyt?

agree, we should better implement swapping out the programId

Finally implemented the programId override as it enhances the usability of these functions

ye, there are similar things we'd want to do on the evm side I think wherein the deployments/release process also includes a hash or some deterministic way to derive the code we are revering to on a release.

can fit into this as well.

Reinis-FRP

nice, this is much better that we had before!

md0x · 2024-12-19T10:56:02Z

src/DeploymentUtils.ts

-export function getDeployedAddress(contractName: string, networkId: number, throwOnError = true): string | undefined {
+export function getDeployedAddress(
+  contractName: string,
+  networkId: number | string,


Network id 1810017368444177321 (solana-devnet) overflows js numbers so we need to pass it as a string

Signed-off-by: Pablo Maldonado <[email protected]>

chrismaree · 2024-12-20T10:13:50Z

package.json

@@ -26,10 +26,11 @@
    "lint-fix": "yarn prettier --write **/*.js **/*.ts ./programs/**/*.rs ./contracts**/*.sol && cargo +nightly fmt  --all && cargo clippy",
    "clean-fast": "for dir in node_modules cache cache-zk artifacts artifacts-zk dist typechain; do mv \"${dir}\" \"_${dir}\"; rm -rf \"_${dir}\" &; done",
    "clean": "rm -rf node_modules cache cache-zk artifacts artifacts-zk dist typechain",
+    "generate-svm-assets": "sh ./scripts/generate-svm-assets.sh",


we should think about making this file easier to reason about with this new command you've added. the equivalent evm command is generate-contract-types. I tried with the other commands to make it clear what they are (solidity/js/rust/evm/svm) but this one is now a bit inconsistent. perhaps if we call it generate-svm-assets and then re-name the generate-contract-types to generate-evm-assets?

also, I think that given this command is not yet within the prepublish command we could actually be safe to merge this into master without it joining the released package.

Updated ✅

also, I think that given this command is not yet within the prepublish command we could actually be safe to
merge this into master without it joining the released package.

I think it is, its part of the build as we need to run yarn generate-svm-assets before yarn build-ts. See this:

contracts/package.json

Line 33 in 907b7d7

"build": "yarn build-evm && yarn build-svm && yarn generate-svm-assets && yarn build-ts",

Let's wait for @mrice32 & @nicholaspai to see what they think the proposed changes.

Signed-off-by: Pablo Maldonado <[email protected]>

…-is-there-a-type-safe-interface

md0x · 2024-12-20T16:07:45Z

deployments/deployments.json

@@ -163,5 +163,10 @@
    "SpokePool": { "address": "0xeF684C38F94F48775959ECf2012D7E864ffb9dd4", "blockNumber": 1139240 },
    "SpokePoolVerifier": { "address": "0xB4A8d45647445EA9FC3E1058096142390683dBC2", "blockNumber": 1152853 },
    "MulticallHandler": { "address": "0x924a9f036260DdD5808007E1AA95f08eD08aA569", "blockNumber": 1145284 }
+  },
+  "1810017368444177321": {


This is our chain id representation of solana-devnet, see this:

contracts/src/svm/helpers.ts

Lines 8 to 12 in ddbe2fc

export const getSolanaChainId = (cluster: "devnet" | "mainnet"): BigNumber => {

return BigNumber.from(

BigInt(ethers.utils.keccak256(ethers.utils.toUtf8Bytes(`solana-${cluster}`))) & BigInt("0xFFFFFFFFFFFFFFFF")

);

};

…-is-there-a-type-safe-interface

Signed-off-by: Pablo Maldonado <[email protected]>

socket-security · 2024-12-20T17:24:57Z

🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎

To accept the risk, merge this PR and you will not be notified again.

Alert	Package	Note	Source	CI
Critical CVE	npm/[email protected]	CVE: GHSA-67hx-6x53-jw92 Babel vulnerable to arbitrary code execution when compiling specifically crafted malicious code (CRITICAL) Affected versions: < 7.23.2 Patched version: No patched versions	`yarn.lock`	⚠︎
Critical CVE	npm/@openzeppelin/[email protected]	CVE: GHSA-5vp3-v4hc-gx76 UUPSUpgradeable vulnerability in @openzeppelin/contracts (CRITICAL) Affected versions: >= 4.1.0, < 4.3.2 Patched version: 4.3.2	`yarn.lock`	⚠︎
Critical CVE	npm/@openzeppelin/[email protected]	CVE: GHSA-fg47-3c2x-m2wr TimelockController vulnerability in OpenZeppelin Contracts (CRITICAL) Affected versions: >= 4.0.0, < 4.3.1 Patched version: 4.3.1	`yarn.lock`	⚠︎

View full report↗︎

Next steps

What is a critical CVE?

Contains a Critical Common Vulnerability and Exposure (CVE).

Remove or replace dependencies that include known critical CVEs. Consumers can use dependency overrides or npm audit fix --force to remove vulnerable dependencies.

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/[email protected] or ignore all packages with @SocketSecurity ignore-all

@SocketSecurity ignore npm/[email protected]
@SocketSecurity ignore npm/@openzeppelin/[email protected]

Signed-off-by: Pablo Maldonado <[email protected]>

socket-security · 2024-12-20T17:32:50Z

Report too large to display inline

View full report↗︎

feat(svm): add types to dist

dd4969f

Signed-off-by: Pablo Maldonado <[email protected]>

md0x added 3 commits December 18, 2024 15:06

feat(svm): types

0bca3a8

Signed-off-by: Pablo Maldonado <[email protected]>

fix: ci

a09be49

Signed-off-by: Pablo Maldonado <[email protected]>

feat: add getters

6de6d5e

Signed-off-by: Pablo Maldonado <[email protected]>

md0x changed the title ~~feat(svm): add types to dist~~ feat(svm): include solana artifacts in package build output Dec 18, 2024

md0x commented Dec 18, 2024

View reviewed changes

feat: export only assets

c647999

Signed-off-by: Pablo Maldonado <[email protected]>

md0x marked this pull request as ready for review December 18, 2024 17:47

md0x requested review from chrismaree and Reinis-FRP December 18, 2024 17:47

md0x added 2 commits December 18, 2024 17:53

fix: missing old import

916449e

Signed-off-by: Pablo Maldonado <[email protected]>

fix: export svm

97973eb

Signed-off-by: Pablo Maldonado <[email protected]>

md0x commented Dec 18, 2024

View reviewed changes

md0x force-pushed the pablo/acx-3481-look-into-typechain-for-svm-is-there-a-type-safe-interface branch from d3a8991 to 97973eb Compare December 18, 2024 19:21

md0x commented Dec 18, 2024

View reviewed changes

Reinis-FRP approved these changes Dec 19, 2024

View reviewed changes

md0x force-pushed the pablo/acx-3481-look-into-typechain-for-svm-is-there-a-type-safe-interface branch from 136d7d2 to 10a73f9 Compare December 19, 2024 10:53

md0x commented Dec 19, 2024

View reviewed changes

md0x force-pushed the pablo/acx-3481-look-into-typechain-for-svm-is-there-a-type-safe-interface branch 4 times, most recently from 518bf52 to b766c81 Compare December 19, 2024 11:28

feat: read program id from deployed addresses or pass it as arg

804fa7a

Signed-off-by: Pablo Maldonado <[email protected]>

md0x force-pushed the pablo/acx-3481-look-into-typechain-for-svm-is-there-a-type-safe-interface branch from b766c81 to 804fa7a Compare December 19, 2024 11:29

Reinis-FRP previously approved these changes Dec 19, 2024

View reviewed changes

md0x requested review from nicholaspai and mrice32 December 20, 2024 09:30

chrismaree reviewed Dec 20, 2024

View reviewed changes

md0x added 2 commits December 20, 2024 15:20

refactor: rename generate-evm-assets

8ec0fe4

Signed-off-by: Pablo Maldonado <[email protected]>

Merge branch 'master' into pablo/acx-3481-look-into-typechain-for-svm…

907b7d7

…-is-there-a-type-safe-interface

md0x commented Dec 20, 2024

View reviewed changes

md0x added 2 commits December 20, 2024 17:22

Merge branch 'master' into pablo/acx-3481-look-into-typechain-for-svm…

9d0c7a5

…-is-there-a-type-safe-interface

refactor: dif readme

3ec7934

Signed-off-by: Pablo Maldonado <[email protected]>

md0x added 2 commits December 20, 2024 17:25

refactor: remove diff readme

5b33a4a

Signed-off-by: Pablo Maldonado <[email protected]>

fix: imports

2be0052

Signed-off-by: Pablo Maldonado <[email protected]>

Reinis-FRP mentioned this pull request Dec 23, 2024

fix: script to fill jupiter swap #819

Open

md0x dismissed Reinis-FRP’s stale review via 2be0052 December 31, 2024 04:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(svm): include solana artifacts in package build output #806

feat(svm): include solana artifacts in package build output #806

md0x commented Dec 18, 2024 •

edited

Loading

linear bot commented Dec 18, 2024

md0x Dec 18, 2024

md0x Dec 18, 2024

md0x Dec 18, 2024

md0x Dec 18, 2024 •

edited

Loading

Reinis-FRP Dec 19, 2024

md0x Dec 19, 2024

chrismaree Dec 20, 2024

Reinis-FRP left a comment

md0x Dec 19, 2024

chrismaree Dec 20, 2024

md0x Dec 20, 2024

md0x Dec 20, 2024

socket-security bot commented Dec 20, 2024 •

edited

Loading

socket-security bot commented Dec 20, 2024

	export const getSolanaChainId = (cluster: "devnet" \| "mainnet"): BigNumber => {
	return BigNumber.from(
	BigInt(ethers.utils.keccak256(ethers.utils.toUtf8Bytes(`solana-${cluster}`))) & BigInt("0xFFFFFFFFFFFFFFFF")
	);
	};

feat(svm): include solana artifacts in package build output #806

Are you sure you want to change the base?

feat(svm): include solana artifacts in package build output #806

Conversation

md0x commented Dec 18, 2024 • edited Loading

linear bot commented Dec 18, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

md0x Dec 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Reinis-FRP left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

socket-security bot commented Dec 20, 2024 • edited Loading

Next steps

socket-security bot commented Dec 20, 2024

md0x commented Dec 18, 2024 •

edited

Loading

md0x Dec 18, 2024 •

edited

Loading

socket-security bot commented Dec 20, 2024 •

edited

Loading