add: ops script to initialize gateway program #20

brewmaster012 · 2024-08-26T23:08:49Z

No description provided.

codecov-commenter · 2024-08-26T23:13:32Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 9.17%. Comparing base (08b8147) to head (3a7e0d5).
Report is 1 commits behind head on main.

Additional details and impacted files

@@          Coverage Diff          @@
##            main     #20   +/-   ##
=====================================
  Coverage   9.17%   9.17%           
=====================================
  Files          1       1           
  Lines        218     218           
=====================================
  Hits          20      20           
  Misses       198     198

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

lumtis · 2024-08-30T09:10:23Z

Anchor.toml

@@ -16,3 +16,4 @@ wallet = "~/.config/solana/id.json"

 [scripts]
 test = "yarn run ts-mocha -p ./tsconfig.json -t 1000000 tests/**/*.ts"
+#test = "yarn run ts-mocha -p ./tsconfig.json -t 1000000 tests/ops.ts"


Suggested change

#test = "yarn run ts-mocha -p ./tsconfig.json -t 1000000 tests/ops.ts"

lumtis · 2024-08-30T09:11:37Z

tests/ops.ts

+// uncomment Anchor.toml [test] to run this script
+// #test = "yarn run ts-mocha -p ./tsconfig.json -t 1000000 tests/ops.ts"


Unclear what does this mean. We should put instruction to run the script in the readme

lumtis · 2024-08-30T09:14:40Z

tests/ops.ts

+    console.log("=====================================");
+    console.log("BEGIN OPS ON DEVNET........");
+
+    const provider = anchor.AnchorProvider.local("https://api.devnet.solana.com");


Comment above mention it c mainnet but here the URL is devnet. I think we should use an environment variable for it

Agree, same as mentioned before: we could group all constants in const.ts, adding the ability to override them via env var.

lumtis · 2024-08-30T09:16:35Z

tests/ops.ts

+    // Uncomment the following to initialize the gateway program;
+    // can only be initialized once
+    // try {
+    //     const inst = await gatewayProgram.methods.initialize(tssAddressArray,chain_id_bn).transaction();
+    //     console.log("initialize inst:", inst);
+    //     const tx = await anchor.web3.sendAndConfirmTransaction(conn, inst, [wallet]);
+    //     console.log("tx:", tx);
+    // } catch (err) {
+    //    console.log("initialize err:", err);
+    // }


We should rather have argument or using environment variable to customize script logic

lumtis · 2024-08-30T09:16:44Z

tests/ops.ts

+    // const pdaAccountData = await gatewayProgram.account.pda.fetch(pdaAccount);
+    try {
+        console.log("fetching pda account data....", pdaAccount.toBase58());
+        // const data = await gatewayProgram.account.pda.fetch(pdaAccount);


Suggested change

// const data = await gatewayProgram.account.pda.fetch(pdaAccount);

lumtis · 2024-08-30T09:16:50Z

tests/ops.ts

+
+    const pdaAccountInfo = await conn.getAccountInfo(pdaAccount);
+    console.log("pdaAccountInfoData:", pdaAccountInfo.data);
+    // const pdaAccountData = await gatewayProgram.account.pda.fetch(pdaAccount);


Suggested change

// const pdaAccountData = await gatewayProgram.account.pda.fetch(pdaAccount);

lumtis · 2024-08-30T09:16:57Z

tests/ops.ts

+        console.log(`depositPaused: ${ainfo.depositPaused}`);
+        console.log(`chain_id: ${ainfo.chainId}`);
+
+        // console.log(`pda data:`, ainfo);


Suggested change

// console.log(`pda data:`, ainfo);

lumtis · 2024-08-30T09:17:06Z

tests/ops.ts

+    // console.log(`pda account data: nonce ${pdaAccountData.nonce}`);
+    // const hexAddr = bufferToHex(Buffer.from(pdaAccountData.tssAddress));
+    // console.log(`pda account data: tss address ${hexAddr}`);
+    // console.log(`authority: ${pdaAccountData.authority.toBase58()}`);


Suggested change

// console.log(`pda account data: nonce ${pdaAccountData.nonce}`);

// const hexAddr = bufferToHex(Buffer.from(pdaAccountData.tssAddress));

// console.log(`pda account data: tss address ${hexAddr}`);

// console.log(`authority: ${pdaAccountData.authority.toBase58()}`);

lumtis · 2024-08-30T09:18:08Z

tests/ops.ts

@@ -0,0 +1,90 @@
+// this is for ops on devnet/mainnet


Unclear what ops means, if this is to deploy the gateway, it should be reflected in the name of the script?

fbac · 2024-09-02T10:55:21Z

tests/ops.ts

+import {bufferToHex} from "ethereumjs-util";
+import {getAccount} from "@solana/spl-token";
+
+const programId = new web3.PublicKey("ZETAjseVjuFsxdRxo6MmTCvqFwb3ZHUx56Co3vCmGis");


Can we move all hardcoded values to constants in a separate file, and add the ability of overriding them via env vars?

fbac · 2024-09-02T10:55:55Z

tests/ops.ts

+    console.log("=====================================");
+    console.log("BEGIN OPS ON DEVNET........");
+
+    const provider = anchor.AnchorProvider.local("https://api.devnet.solana.com");


Agree, same as mentioned before: we could group all constants in const.ts, adding the ability to override them via env var.

brewmaster012 · 2024-09-12T00:16:26Z

thanksf or the comments, but to clarify: the ops script serves two purposes:

as a log of deployment
template for deployment for mainnet

This is one-off script (at most two-off). The commented code is there to prevent accidental re-deployment and can be uncommented for mainnet deployment.

As long as it works I will not further improve it.

lumtis · 2024-10-01T13:53:08Z

thanksf or the comments, but to clarify: the ops script serves two purposes:

as a log of deployment

template for deployment for mainnet

This is one-off script (at most two-off). The commented code is there to prevent accidental re-deployment and can be uncommented for mainnet deployment.

As long as it works I will not further improve it.

Not sure to understand the point. If the script is not used in practice and just as a template, the we can have a playbook instead of it.
If the script is aimed to be used in production, we should have production grade code. Having commented code for no reason is confusing, we should write code as if an entirely new team could take ownership of the codebase and know how to use the script.

brewmaster012 · 2024-11-22T20:51:31Z

closing this as it's not suitable for merging.
Will keep the branch alive as a record.

brewmaster012 requested review from lumtis, fbac and ws4charlie as code owners August 26, 2024 23:08

add ops script

3ddbccb

brewmaster012 force-pushed the readme-minor branch from 57c2299 to 3ddbccb Compare August 26, 2024 23:10

fix type

3a7e0d5

brewmaster012 force-pushed the readme-minor branch from da90859 to 3a7e0d5 Compare August 26, 2024 23:15

lumtis reviewed Aug 30, 2024

View reviewed changes

fbac reviewed Sep 2, 2024

View reviewed changes

fbac self-requested a review September 24, 2024 10:45

fbac approved these changes Sep 24, 2024

View reviewed changes

brewmaster012 closed this Nov 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add: ops script to initialize gateway program #20

add: ops script to initialize gateway program #20

brewmaster012 commented Aug 26, 2024

codecov-commenter commented Aug 26, 2024 •

edited

Loading

lumtis Aug 30, 2024

lumtis Aug 30, 2024

lumtis Aug 30, 2024

fbac Sep 2, 2024

lumtis Aug 30, 2024

lumtis Aug 30, 2024

lumtis Aug 30, 2024

lumtis Aug 30, 2024

lumtis Aug 30, 2024

lumtis Aug 30, 2024

fbac Sep 2, 2024

fbac Sep 2, 2024

brewmaster012 commented Sep 12, 2024 •

edited

Loading

lumtis commented Oct 1, 2024

brewmaster012 commented Nov 22, 2024

		// uncomment Anchor.toml [test] to run this script
		// #test = "yarn run ts-mocha -p ./tsconfig.json -t 1000000 tests/ops.ts"

add: ops script to initialize gateway program #20

add: ops script to initialize gateway program #20

Conversation

brewmaster012 commented Aug 26, 2024

codecov-commenter commented Aug 26, 2024 • edited Loading

Codecov Report

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brewmaster012 commented Sep 12, 2024 • edited Loading

lumtis commented Oct 1, 2024

brewmaster012 commented Nov 22, 2024

codecov-commenter commented Aug 26, 2024 •

edited

Loading

brewmaster012 commented Sep 12, 2024 •

edited

Loading