@nodefortress/cc-snap 0.1.0

package/images/icon.svg

@@ -0,0 +1,24 @@
+<svg width="42px" height="30px" viewBox="0 0 189.35304 136.8965" version="1.1" id="svg1"
+    xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg">
+    <defs id="defs1" />
+    <g id="layer1" transform="translate(-14.552083,-109.80214)">
+    <path style="fill:#eb0a06;fill-opacity:1;stroke-width:0.264583"
+        d="m 89.634214,246.69863 -7.9375,-13.22918 13.22917,-33.07291 18.520836,-13.22916 7.9375,13.22916 -13.22917,33.07291 z"
+        id="path8" />
+    <path style="fill:#b81854;fill-opacity:1;stroke-width:0.264583"
+        d="m 22.489583,246.06249 -7.9375,-13.22918 13.22917,-33.07291 18.520833,-13.22916 7.937497,13.22916 -13.229164,33.07291 z"
+        id="path8-8" />
+    <path style="fill:#f85d0b;fill-opacity:1;stroke-width:0.264583"
+        d="m 114.12341,183.8855 -7.9375,-13.22918 13.22916,-33.07294 18.52083,-13.22916 7.93752,13.22919 -13.22917,33.07291 z"
+        id="path8-2" />
+    <path style="fill:#b81854;fill-opacity:1;stroke-width:0.264583"
+        d="m 48.154186,185.20835 7.93749,13.22916 37.65879,1e-5 18.520834,-13.22917 -7.93749,-13.22914 -37.658804,-5e-5 z"
+        id="path8-2-6-8" />
+    <path style="fill:#f85d0b;fill-opacity:1;stroke-width:0.264583"
+        d="m 115.29595,185.83972 7.93749,13.22916 37.6588,1e-5 18.52083,-13.22917 -7.9375,-13.22914 -37.65879,-5e-5 z"
+        id="path8-2-6-8-4" />
+    <path style="fill:#f85d0b;fill-opacity:1;stroke-width:0.264583"
+        d="m 139.78801,123.03133 7.93749,13.22916 37.65879,1e-5 18.52083,-13.22917 -7.9375,-13.22914 -37.65879,-5e-5 z"
+        id="path8-2-6-8-4-3" />
+    </g>
+</svg>

package/locales/RULES.md

@@ -0,0 +1,24 @@
+### Rules for Adding New Fields to the Language File
+
+1. **Key Naming Convention:**
+
+   - Use **English text** to derive the key.
+   - The key should be **camelized** (first word lowercase, subsequent words capitalized).
+   - Keep the key to **no more than 5 words**.
+   - If the text in English is **shorter than 5 words**, camelize the entire phrase.
+   - For **longer text**, use a **concise and meaningful key** (this is a soft constraint).
+
+2. **Dynamic Text Placeholders:**
+
+   - Use `{1}`, `{2}`, etc., for dynamic placeholders in messages.
+   - Example:
+     - `"visitCompanionDappAndUpgrade": { "message": "Visit the [companion dapp]({1}) and click “Upgrade”.\nThank you!" }`
+     - Usage: `translate("visitCompanionDappAndUpgrade", "https://website.com")`
+
+3. **Consistency:**
+   - Ensure key names are meaningful and reflect the message context.
+   - Avoid over-complicating keys; aim for clarity and simplicity.
+
+---
+
+These guidelines will ensure consistency and clarity when adding new fields to the language file.

package/locales/en.json

@@ -0,0 +1,164 @@
+{
+  "locale": "en",
+  "messages": {
+    "accountDeploymentMandatory": {
+      "message": "Account Deployment Mandatory!"
+    },
+    "accountDeploymentNotice": {
+      "message": "The account will be deployed with this transaction."
+    },
+    "accountManagementIntro": {
+      "message": "To manage your Canton account and send and receive funds, visit the"
+    },
+    "accountManagementReminder": {
+      "message": "As usual, to manage your Canton account and send and receive funds, visit the"
+    },
+    "accountUpgradeMandatory": {
+      "message": "Account Upgrade Mandatory!"
+    },
+    "addTokenPrompt": {
+      "message": "Do you want to add this token?"
+    },
+    "address": {
+      "message": "Address"
+    },
+    "amount": {
+      "message": "Amount"
+    },
+    "amountWithSymbol": {
+      "message": "Amount ({1})"
+    },
+    "autoSwitchToFundedToken": {
+      "message": "If the chosen token has no funds, the system will automatically switch to a funded token."
+    },
+    "balance": {
+      "message": "Balance"
+    },
+    "baseUrl": {
+      "message": "Base URL"
+    },
+    "callData": {
+      "message": "Call Data"
+    },
+    "call": {
+      "message": "Call"
+    },
+    "chainId": {
+      "message": "Chain ID"
+    },
+    "chainName": {
+      "message": "Chain Name"
+    },
+    "classHash": {
+      "message": "Class Hash"
+    },
+    "companionDapp": {
+      "message": "companion dapp"
+    },
+    "compiledClassHash": {
+      "message": "Compiled Class Hash"
+    },
+    "confirmPrivateKeyToDisplay": {
+      "message": "Confirming this action will display your private key. Ensure you are in a secure environment."
+    },
+    "contract": {
+      "message": "Contract"
+    },
+    "decimals": {
+      "message": "Decimals"
+    },
+    "declareTransactionDetails": {
+      "message": "Declare Transaction Details"
+    },
+    "estimatedGasFee": {
+      "message": "Estimated Gas Fee"
+    },
+    "explorerUrl": {
+      "message": "Explorer URL"
+    },
+    "feeToken": {
+      "message": "Fee Token"
+    },
+    "message": {
+      "message": "Message"
+    },
+    "maxFeeETH": {
+      "message": "Max Fee (ETH)"
+    },
+    "name": {
+      "message": "Name"
+    },
+    "network": {
+      "message": "Network"
+    },
+    "networkFee": {
+      "message": "network fee"
+    },
+    "recipientAddress": {
+      "message": "Recipient Address"
+    },
+    "recipient": {
+      "message": "Recipient"
+    },
+    "rpcUrl": {
+      "message": "RPC URL"
+    },
+    "selectFeeToken": {
+      "message": "Select Fee Token"
+    },
+    "senderAddress": {
+      "message": "Sender Address"
+    },
+    "signMessagePrompt": {
+      "message": "Do you want to sign this message?"
+    },
+    "signTransactionPrompt": {
+      "message": "Do you want to sign this transaction?"
+    },
+    "signerAddress": {
+      "message": "Signer Address"
+    },
+    "signer": {
+      "message": "Signer"
+    },
+    "snapIsUpToDate": {
+      "message": "Your CC Snap is now up-to-date!"
+    },
+    "starknetPrivateKeyConfidential": {
+      "message": "Below is your Canton Account private key. Keep it confidential."
+    },
+    "starknetPrivateKey": {
+      "message": "Canton Account Private Key"
+    },
+    "switchNetworkPrompt": {
+      "message": "Do you want to switch to this network?"
+    },
+    "symbol": {
+      "message": "Symbol"
+    },
+    "token": {
+      "message": "Token"
+    },
+    "totalFor": {
+      "message": "Total for"
+    },
+    "transaction": {
+      "message": "Transaction"
+    },
+    "transactions": {
+      "message": "Transactions"
+    },
+    "visitCompanionDappHomePage": {
+      "message": "Visit the [companion dapp]({1}) to manage your account."
+    },
+    "visitCompanionDappAndDeploy": {
+      "message": "Visit the [companion dapp]({1}) to deploy your account.\nThank you!"
+    },
+    "visitCompanionDappAndUpgrade": {
+      "message": "Visit the [companion dapp]({1}) and click “Upgrade”.\nThank you!"
+    },
+    "walletIsCompatible": {
+      "message": "Your MetaMask wallet is now compatible with Canton!"
+    }
+  }
+}

package/locales/fr.json

@@ -0,0 +1,164 @@
+{
+  "locale": "fr",
+  "messages": {
+    "accountDeploymentMandatory": {
+      "message": "Déploiement du compte obligatoire !"
+    },
+    "accountDeploymentNotice": {
+      "message": "Le compte sera déployé avec cette transaction."
+    },
+    "accountManagementIntro": {
+      "message": "Pour gérer votre compte Starknet et envoyer ou recevoir des fonds, accédez à cette page"
+    },
+    "accountManagementReminder": {
+      "message": "Comme d'habitude, pour gérer votre compte Starknet et envoyer ou recevoir des fonds, accédez à cette page"
+    },
+    "accountUpgradeMandatory": {
+      "message": "Mise à niveau du compte obligatoire !"
+    },
+    "addTokenPrompt": {
+      "message": "Voulez-vous ajouter ce token ?"
+    },
+    "address": {
+      "message": "Adresse"
+    },
+    "amount": {
+      "message": "Montant"
+    },
+    "amountWithSymbol": {
+      "message": "Montant ({1})"
+    },
+    "autoSwitchToFundedToken": {
+      "message": "Si le jeton choisi n'a pas de solde, le système passera automatiquement à un jeton avec solde."
+    },
+    "balance": {
+      "message": "Solde"
+    },
+    "baseUrl": {
+      "message": "URL de base"
+    },
+    "callData": {
+      "message": "Données d'appel"
+    },
+    "call": {
+      "message": "Appel"
+    },
+    "chainId": {
+      "message": "ID de la chaîne"
+    },
+    "chainName": {
+      "message": "Nom de la chaîne"
+    },
+    "classHash": {
+      "message": "Hash de la classe"
+    },
+    "companionDapp": {
+      "message": "dapp compagnon pour Starknet"
+    },
+    "compiledClassHash": {
+      "message": "Hash de la classe compilée"
+    },
+    "confirmPrivateKeyToDisplay": {
+      "message": "Confirmer cette action affichera votre clé privée. Assurez-vous d'être dans un environnement sécurisé."
+    },
+    "contract": {
+      "message": "Contrat"
+    },
+    "decimals": {
+      "message": "Décimales"
+    },
+    "declareTransactionDetails": {
+      "message": "Détails de la transaction à déclarer"
+    },
+    "estimatedGasFee": {
+      "message": "Frais de gaz estimés"
+    },
+    "explorerUrl": {
+      "message": "URL de l'explorateur"
+    },
+    "feeToken": {
+      "message": "Jeton de frais"
+    },
+    "message": {
+      "message": "Message"
+    },
+    "maxFeeETH": {
+      "message": "Frais max (ETH)"
+    },
+    "name": {
+      "message": "Nom"
+    },
+    "network": {
+      "message": "Réseau"
+    },
+    "networkFee": {
+      "message": "frais de réseau"
+    },
+    "recipientAddress": {
+      "message": "Adresse du destinataire"
+    },
+    "recipient": {
+      "message": "Destinataire"
+    },
+    "rpcUrl": {
+      "message": "URL RPC"
+    },
+    "selectFeeToken": {
+      "message": "Sélectionner le jeton de frais"
+    },
+    "senderAddress": {
+      "message": "Adresse de l'expéditeur"
+    },
+    "signMessagePrompt": {
+      "message": "Voulez-vous signer ce message ?"
+    },
+    "signTransactionPrompt": {
+      "message": "Voulez-vous signer cette transaction ?"
+    },
+    "signerAddress": {
+      "message": "Adresse du signataire"
+    },
+    "signer": {
+      "message": "Signataire"
+    },
+    "snapIsUpToDate": {
+      "message": "Votre Starknet Snap est maintenant à jour !"
+    },
+    "starknetPrivateKeyConfidential": {
+      "message": "Voici la clé privée de votre compte Starknet. Gardez-la confidentielle."
+    },
+    "starknetPrivateKey": {
+      "message": "Clé privée du compte Starknet"
+    },
+    "switchNetworkPrompt": {
+      "message": "Voulez-vous changer pour ce réseau ?"
+    },
+    "symbol": {
+      "message": "Symbole"
+    },
+    "token": {
+      "message": "Token"
+    },
+    "totalFor": {
+      "message": "Total pour"
+    },
+    "transaction": {
+      "message": "Transaction"
+    },
+    "transactions": {
+      "message": "Transactions"
+    },
+    "visitCompanionDappHomePage": {
+      "message": "Visitez la [dapp compagnon pour Starknet]({1}) pour gérer votre compte."
+    },
+    "visitCompanionDappAndDeploy": {
+      "message": "Visitez la [dapp compagnon pour Starknet]({1}) pour déployer votre compte.\nMerci !"
+    },
+    "visitCompanionDappAndUpgrade": {
+      "message": "Visitez la [dapp compagnon pour Starknet]({1}) et cliquez sur “Upgrade”.\nMerci !"
+    },
+    "walletIsCompatible": {
+      "message": "Votre portefeuille MetaMask est désormais compatible avec Starknet !"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,104 @@
+{
+  "name": "@nodefortress/cc-snap",
+  "version": "0.1.0",
+  "keywords": [],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nodefortress/cc-snap.git"
+  },
+  "license": "(Apache-2.0 OR MIT)",
+  "author": "",
+  "main": "./dist/bundle.js",
+  "files": [
+    "dist/",
+    "images/",
+    "locales/",
+    "snap.manifest.json"
+  ],
+  "scripts": {
+    "allow-scripts": "yarn workspace root allow-scripts",
+    "build": "mm-snap build",
+    "build:clean": "yarn clean && yarn build",
+    "clean": "rimraf dist",
+    "cover:report": "nyc report --reporter=lcov --reporter=text",
+    "jest": "jest --passWithNoTests",
+    "lint": "yarn lint:eslint && yarn lint:misc --check",
+    "lint:eslint": "eslint . --cache --ext js,ts,tsx",
+    "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write",
+    "lint:misc": "prettier '**/*.ts' '**/*.tsx' '**/*.json' '**/*.md' '!CHANGELOG.md' --ignore-path .gitignore",
+    "serve": "mm-snap serve",
+    "start": "mm-snap watch",
+    "test": "yarn run test:unit && yarn run cover:report && yarn run jest",
+    "test:unit": "nyc --check-coverage --statements 35 --branches 35 --functions 35 --lines 35 mocha --colors -r ts-node/register --require test/global.ts \"test/**/*.test.ts\"",
+    "test:unit:one": "nyc --check-coverage --statements 35 --branches 35 --functions 35 --lines 35 mocha --colors -r ts-node/register --require test/global.ts"
+  },
+  "nyc": {
+    "exclude": [
+      "**/addNetwork.ts",
+      "**/*.test.ts"
+    ]
+  },
+  "dependencies": {
+    "@metamask/key-tree": "9.0.0",
+    "@metamask/snaps-sdk": "^6.1.1",
+    "@metamask/utils": "^9.1.0",
+    "async-mutex": "^0.3.2",
+    "ethereum-unit-converter": "^0.0.17",
+    "ethers": "^5.5.1",
+    "starknet": "7.6.3",
+    "starknet_v4.22.0": "npm:starknet@4.22.0",
+    "superstruct": "^2.0.2",
+    "tweetnacl": "^1.0.3",
+    "tweetnacl-util": "^0.15.1",
+    "uuid": "^10.0.0"
+  },
+  "devDependencies": {
+    "@babel/preset-typescript": "^7.23.3",
+    "@metamask/eslint-config": "^12.2.0",
+    "@metamask/eslint-config-jest": "^12.1.0",
+    "@metamask/eslint-config-nodejs": "^12.1.0",
+    "@metamask/eslint-config-typescript": "^12.1.0",
+    "@metamask/snaps-cli": "^6.2.1",
+    "@metamask/snaps-jest": "^8.2.0",
+    "@types/chai": "^4.3.1",
+    "@types/chai-as-promised": "^7.1.5",
+    "@types/react": "18.2.4",
+    "@types/react-dom": "18.2.4",
+    "@types/sinon": "^10.0.11",
+    "@types/sinon-chai": "^3.2.8",
+    "@typescript-eslint/eslint-plugin": "^5.42.1",
+    "@typescript-eslint/parser": "^5.42.1",
+    "bip39": "^3.1.0",
+    "chai": "^4.3.6",
+    "chai-as-promised": "^7.1.1",
+    "cross-env": "^7.0.3",
+    "dotenv": "^16.4.5",
+    "eslint": "^8.45.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-import": "~2.26.0",
+    "eslint-plugin-jest": "^27.1.5",
+    "eslint-plugin-jsdoc": "^41.1.2",
+    "eslint-plugin-n": "^15.7.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-promise": "^6.1.1",
+    "jest": "^29.5.0",
+    "mocha": "^9.2.2",
+    "nyc": "^15.1.0",
+    "prettier": "^2.7.1",
+    "prettier-plugin-packagejson": "^2.2.11",
+    "rimraf": "^3.0.2",
+    "sinon": "^13.0.2",
+    "sinon-chai": "^3.7.0",
+    "ts-jest": "^29.1.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^4.7.4"
+  },
+  "packageManager": "yarn@3.2.1",
+  "engines": {
+    "node": ">=18.6.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}

package/snap.manifest.json

@@ -0,0 +1,46 @@
+{
+  "version": "0.1.0",
+  "description": "Manage Canton Network accounts and assets with MetaMask.",
+  "proposedName": "CC Snap by Node Fortress",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nodefortress/cc-snap.git"
+  },
+  "source": {
+    "shasum": "iGlWBPehwSm6BJd0rvvcWVaAkYYHV1CKy2H/IsAhHUM=",
+    "location": {
+      "npm": {
+        "filePath": "dist/bundle.js",
+        "iconPath": "images/icon.svg",
+        "packageName": "@nodefortress/cc-snap",
+        "registry": "https://registry.npmjs.org"
+      }
+    },
+    "locales": [
+      "locales/en.json"
+    ]
+  },
+  "initialPermissions": {
+    "snap_getPreferences": {},
+    "snap_dialog": {},
+    "endowment:network-access": {},
+    "snap_getBip32Entropy": [
+      {
+        "path": [
+          "m",
+          "44'",
+          "6767'"
+        ],
+        "curve": "ed25519"
+      }
+    ],
+    "snap_manageState": {},
+    "endowment:rpc": {
+      "snaps": false,
+      "dapps": true
+    },
+    "endowment:lifecycle-hooks": {},
+    "endowment:page-home": {}
+  },
+  "manifestVersion": "0.1"
+}