Merge pull request #50 from sun-rhythms/fix-tests-and-tutorials-links

ton-community · Oct 17, 2023 · 6ce47ba · 6ce47ba
2 parents d262be1 + 2fb7d32
commit 6ce47ba
Show file tree

Hide file tree

Showing 15 changed files with 80 additions and 32 deletions.
diff --git a/01-wallet/test/npmton/step7.ts b/01-wallet/test/npmton/step7.ts
@@ -5,11 +5,16 @@ import { mnemonicToWalletKey } from "@ton/crypto";
 import { WalletContractV4 } from "@ton/ton";
 
 async function main() {
-  // GH Actions tests use GH secret as mnemonic
-  // to run this test locally, you should create the file .env in the project root
-  // with your mnemonic phrase (according to repo README)
-  // and change step7.expected wallet address to yours
-  const mnemonic = process.env.MNEMONIC; 
+  // Notice:
+  // Due to limitations in GitHub Actions, we are unable to use secrets to 
+  // store a secure mnemonic for the wallet during the testing of pull 
+  // requests from forked repositories by our contributors. 
+  // As a result, we are currently using a public wallet with an exposed mnemonic in 
+  // our test files when running tests in GH Actions.
+  // const mnemonic = process.env.MNEMONIC ;
+  const mnemonic =
+    'table jungle security cargo adjust barrel dance net permit pig soap simple rabbit upgrade unique update firm between deer minor ship thought ride physical';
+
 
     // open wallet v4 (notice the correct wallet version here)
   const key = await mnemonicToWalletKey(mnemonic!.split(" "));

diff --git a/01-wallet/test/npmton/step8.ts b/01-wallet/test/npmton/step8.ts
@@ -6,7 +6,15 @@ import { mnemonicToWalletKey } from "@ton/crypto";
 import { WalletContractV4, TonClient, fromNano } from "@ton/ton";
 
 async function main() {
-  const mnemonic = process.env.MNEMONIC; 
+  // Notice:
+  // Due to limitations in GitHub Actions, we are unable to use secrets to 
+  // store a secure mnemonic for the wallet during the testing of pull 
+  // requests from forked repositories by our contributors. 
+  // As a result, we are currently using a public wallet with an exposed mnemonic in 
+  // our test files when running tests in GH Actions.
+  // const mnemonic = process.env.MNEMONIC;
+  const mnemonic =
+    'table jungle security cargo adjust barrel dance net permit pig soap simple rabbit upgrade unique update firm between deer minor ship thought ride physical';
 
   const key = await mnemonicToWalletKey(mnemonic!.split(" "));
   const wallet = WalletContractV4.create({ publicKey: key.publicKey, workchain: 0 });

diff --git a/01-wallet/test/npmton/step9.ts b/01-wallet/test/npmton/step9.ts
@@ -6,8 +6,16 @@ import { mnemonicToWalletKey } from "@ton/crypto";
 import { TonClient, WalletContractV4, internal } from "@ton/ton";
 
 async function main() {
-
-  const mnemonic = process.env.MNEMONIC;
+  // Notice:
+  // Due to limitations in GitHub Actions, we are unable to use secrets to 
+  // store a secure mnemonic for the wallet during the testing of pull 
+  // requests from forked repositories by our contributors. 
+  // As a result, we are currently using a public wallet with an exposed mnemonic in 
+  // our test files when running tests in GH Actions.
+  // const mnemonic = process.env.MNEMONIC;
+  const mnemonic =
+    'table jungle security cargo adjust barrel dance net permit pig soap simple rabbit upgrade unique update firm between deer minor ship thought ride physical';
+
   const key = await mnemonicToWalletKey(mnemonic!.split(" "));
   const wallet = WalletContractV4.create({ publicKey: key.publicKey, workchain: 0 });
 

diff --git a/01-wallet/test/tonweb/step7.ts b/01-wallet/test/tonweb/step7.ts
@@ -5,11 +5,16 @@ import { mnemonicToKeyPair } from "tonweb-mnemonic";
 import TonWeb from "tonweb";
 
 async function main() {
-  // GH Actions tests use GH secret as mnemonic
-  // to run this test locally, you should create the file .env in the project root
-  // with your mnemonic phrase (according to repo README)
-  // and change step7.expected wallet address to yours
-  const mnemonic = process.env.MNEMONIC; 
+  // Notice:
+  // Due to limitations in GitHub Actions, we are unable to use secrets to 
+  // store a secure mnemonic for the wallet during the testing of pull 
+  // requests from forked repositories by our contributors. 
+  // As a result, we are currently using a public wallet with an exposed mnemonic in 
+  // our test files when running tests in GH Actions.
+  // const mnemonic = process.env.MNEMONIC;
+  const mnemonic =
+    'table jungle security cargo adjust barrel dance net permit pig soap simple rabbit upgrade unique update firm between deer minor ship thought ride physical';
+
   const key = await mnemonicToKeyPair(mnemonic!.split(" "));
 
   // open wallet v4 (notice the correct wallet version here)

diff --git a/01-wallet/test/tonweb/step8.ts b/01-wallet/test/tonweb/step8.ts
@@ -6,7 +6,16 @@ import { mnemonicToKeyPair } from "tonweb-mnemonic";
 import TonWeb from "tonweb";
 
 async function main() {
-  const mnemonic = process.env.MNEMONIC; 
+  // Notice:
+  // Due to limitations in GitHub Actions, we are unable to use secrets to 
+  // store a secure mnemonic for the wallet during the testing of pull 
+  // requests from forked repositories by our contributors. 
+  // As a result, we are currently using a public wallet with an exposed mnemonic in 
+  // our test files when running tests in GH Actions.
+  // const mnemonic = process.env.MNEMONIC;
+  const mnemonic =
+    'table jungle security cargo adjust barrel dance net permit pig soap simple rabbit upgrade unique update firm between deer minor ship thought ride physical';
+
   const key = await mnemonicToKeyPair(mnemonic!.split(" "));
 
   // initialize ton rpc client on testnet

diff --git a/01-wallet/test/tonweb/step9.ts b/01-wallet/test/tonweb/step9.ts
@@ -6,7 +6,16 @@ import { mnemonicToKeyPair } from "tonweb-mnemonic";
 import TonWeb from "tonweb";
 
 async function main() {
-  const mnemonic = process.env.MNEMONIC; 
+  // Notice:
+  // Due to limitations in GitHub Actions, we are unable to use secrets to 
+  // store a secure mnemonic for the wallet during the testing of pull 
+  // requests from forked repositories by our contributors. 
+  // As a result, we are currently using a public wallet with an exposed mnemonic in 
+  // our test files when running tests in GH Actions.
+  // const mnemonic = process.env.MNEMONIC;
+  const mnemonic =
+    'table jungle security cargo adjust barrel dance net permit pig soap simple rabbit upgrade unique update firm between deer minor ship thought ride physical';
+
   const key = await mnemonicToKeyPair(mnemonic!.split(" "));
 
   // initialize ton rpc client on testnet

diff --git a/02-contract/test/counter.fc b/02-contract/test/counter.fc
@@ -1,4 +1,4 @@
-#include "stdlib.fc";
+#include "imports/stdlib.fc";
 
 ;; =============== storage =============================
 

diff --git a/02-contract/test/stdlib.fc → 02-contract/test/imports/stdlib.fc b/02-contract/test/stdlib.fc → 02-contract/test/imports/stdlib.fc
diff --git a/02-contract/test/index.sh b/02-contract/test/index.sh
@@ -5,7 +5,7 @@ npm install ts-node
 npm install @ton-community/func-js
 npm install @ton/ton @ton/core @ton/crypto
 npm install @orbs-network/ton-access
-npx func-js stdlib.fc counter.fc --boc counter.cell
+npx func-js ./imports/stdlib.fc counter.fc --boc counter.cell
 npx ts-node deploy.step8.ts > deploy.step8.output.txt
 COUNTER_ADDRESS=`cut -d : -s  -f 2 < deploy.step8.output.txt` npx ts-node getCounter.ts > getCounter.output.txt
 diff getCounter.output.txt getCounter.expected.txt

diff --git a/README.md b/README.md
@@ -46,3 +46,9 @@
   > The official mnemonic appears in Github repo secrets since it's also used in CI. This should be the 24 word mnemonic for a deployed testnet v4 wallet that contains at least 1 TON.
 - Run `./build.sh`
 - Resulting files will be created in the `docs/` directory, ready for Github Pages
+
+### Notice
+
+> Due to limitations in GitHub Actions, we are unable to use secrets to store a secure mnemonic for the wallet during the testing of pull requests from forked repositories by our contributors. 
+> As a result, we are currently using a public wallet with an exposed mnemonic in our test files when running tests in GH Actions.
+
diff --git a/docs/assets/helpers.js b/docs/assets/helpers.js
@@ -16,8 +16,8 @@ const getTutorialLinks = () => document.querySelectorAll("[data=tutorial-link]")
 
 const setSelectedTutorialLink = () => {
   getTutorialLinks().forEach((tutorialLink) => {
-    if(tutorialLink.href === window.location.href) {
-      tutorialLink.classList.add("selected");
+    if (`${tutorialLink.href}/` === window.location.href) {
+      tutorialLink.classList.add('selected');
     }
   });
 };

diff --git a/docs/assets/styles.css b/docs/assets/styles.css
diff --git a/docs/assets/styles.css.map b/docs/assets/styles.css.map
diff --git a/scripts/assets/helpers.js b/scripts/assets/helpers.js
@@ -16,8 +16,8 @@ const getTutorialLinks = () => document.querySelectorAll("[data=tutorial-link]")
 
 const setSelectedTutorialLink = () => {
   getTutorialLinks().forEach((tutorialLink) => {
-    if(tutorialLink.href === window.location.href) {
-      tutorialLink.classList.add("selected");
+    if (`${tutorialLink.href}/` === window.location.href) {
+      tutorialLink.classList.add('selected');
     }
   });
 };

diff --git a/styles.scss b/styles.scss
@@ -29,11 +29,6 @@ a {
   border-bottom: .75px solid #08c9;
 }
 
-a.selected {
-  text-decoration: underline;
-  pointer-events: none;
-}
-
 /* http://meyerweb.com/eric/tools/css/reset/ 
    v2.0 | 20110126
    License: none (public domain)
@@ -617,6 +612,10 @@ a.alogo:hover, a.alogo:visited, a.alogo:link, a.alogo:active {
       font-size: 14px;
       text-decoration: unset;
     }
+    a.selected {
+      text-decoration: underline;
+      pointer-events: none;
+    }
   }
 }