abc-scaffold 1.0.1 → 1.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "abc-scaffold",
-  "version": "1.0.1",
+  "version": "1.0.4",
   "description": "Africa's Blockchain Club — project-agnostic blockchain scaffolding tool",
   "author": "Africa's Blockchain Club",
   "license": "MIT",

package/src/scaffold.js

@@ -68,28 +68,28 @@ Fill in your values in \`.env\`:
 ### 3. Compile contracts
 
 \`\`\`bash
-npm run compile
+npx hardhat compile
 \`\`\`
 
 ### 4. Run tests
 
 \`\`\`bash
-npm test
+npx hardhat test
 \`\`\`
 
-### 5. Start a local Hardhat node
+### 5. Deploy contracts locally
+
+Open two terminals:
 
 \`\`\`bash
+# Terminal 1 — start a local node
 npx hardhat node
-\`\`\`
 
-### 6. Deploy contracts locally
-
-\`\`\`bash
+# Terminal 2 — deploy your contracts
 npx hardhat run scripts/deploy.js --network localhost
 \`\`\`
 
-### 7. Start the frontend
+### 6. Start the frontend
 
 \`\`\`bash
 cd frontend
@@ -295,9 +295,17 @@ export async function scaffold(initialName) {
 
   fs.mkdirSync(targetDir, { recursive: true });
 
-  for (const dir of ['contracts', 'scripts', 'test']) {
-    fs.mkdirSync(path.join(targetDir, dir), { recursive: true });
-    logger.success(`${dir}/`);
+  // Copy starter files — directories are created implicitly by fse.copySync
+  const starterFiles = [
+    ['contracts/MyContract.sol', 'contracts/MyContract.sol'],
+    ['scripts/deploy.js',        'scripts/deploy.js'],
+    ['scripts/upgrade.js',       'scripts/upgrade.js'],
+    ['test/MyContract.test.js',  'test/MyContract.test.js'],
+  ];
+
+  for (const [src, dest] of starterFiles) {
+    fse.copySync(path.join(TEMPLATES, src), path.join(targetDir, dest));
+    logger.success(dest);
   }
 
   // ── Copy configuration files ────────────────────────────────────────────────
@@ -337,7 +345,7 @@ export async function scaffold(initialName) {
   console.log(chalk.cyan(`  cd ${projectName}`));
   console.log(chalk.cyan('  npm install') + chalk.gray('                    # install root dependencies'));
   console.log(chalk.cyan('  cp .env.example .env') + chalk.gray('           # fill in your keys'));
-  console.log(chalk.cyan('  npm run compile') + chalk.gray('                # compile contracts'));
+  console.log(chalk.cyan('  npx hardhat compile') + chalk.gray('            # compile contracts'));
   console.log(chalk.cyan('  cd frontend && npm install') + chalk.gray('     # install frontend dependencies'));
   console.log(chalk.cyan('  npm run dev') + chalk.gray('                    # start the UI'));
   console.log('');

package/templates/contracts/MyContract.sol

@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.26;
+
+contract MyContract {
+    // Your logic here
+}

package/templates/frontend/src/App.css

@@ -19,16 +19,13 @@ body {
   flex-direction: column;
 }
 
-/* ── Main content ── */
 .main {
   flex: 1;
-  max-width: 1100px;
-  margin: 0 auto;
-  padding: 5rem 2rem;
-  width: 100%;
+  display: flex;
+  align-items: center;
+  justify-content: center;
 }
 
-/* ── Hero ── */
 .hero {
   text-align: center;
 }
@@ -44,50 +41,5 @@ body {
 .subtitle {
   font-size: 1.1rem;
   color: #e94560;
-  margin-bottom: 3.5rem;
   font-weight: 500;
 }
-
-/* ── Cards ── */
-.cards {
-  display: grid;
-  grid-template-columns: repeat(auto-fit, minmax(220px, 1fr));
-  gap: 1.5rem;
-  margin-top: 1rem;
-}
-
-.card {
-  background-color: #1a1a2e;
-  border: 1px solid #2a2a4a;
-  border-radius: 12px;
-  padding: 1.75rem 1.5rem;
-  text-align: left;
-  transition: border-color 0.2s ease, transform 0.2s ease;
-}
-
-.card:hover {
-  border-color: #e94560;
-  transform: translateY(-3px);
-}
-
-.card h3 {
-  font-size: 1.05rem;
-  font-weight: 700;
-  color: #ffffff;
-  margin-bottom: 0.6rem;
-}
-
-.card p {
-  font-size: 0.9rem;
-  color: #9090a8;
-  line-height: 1.5;
-}
-
-.card code {
-  background-color: #0d0d1a;
-  color: #e94560;
-  padding: 0.1rem 0.4rem;
-  border-radius: 4px;
-  font-size: 0.85rem;
-  font-family: 'Fira Code', 'Cascadia Code', monospace;
-}

package/templates/frontend/src/App.jsx

@@ -9,25 +9,6 @@ function App() {
         <div className="hero">
           <h1>Your Blockchain Project</h1>
           <p className="subtitle">Scaffolded by Africa's Blockchain Club</p>
-
-          <div className="cards">
-            <div className="card">
-              <h3>📄 Write Contracts</h3>
-              <p>Add your Solidity files to <code>contracts/</code></p>
-            </div>
-            <div className="card">
-              <h3>⚙️ Compile</h3>
-              <p>Run <code>npm run compile</code> in the project root</p>
-            </div>
-            <div className="card">
-              <h3>🚀 Deploy</h3>
-              <p>Add a script to <code>scripts/</code> and run it with Hardhat</p>
-            </div>
-            <div className="card">
-              <h3>🔗 Connect</h3>
-              <p>Use the wallet button above to connect MetaMask, then interact with your contracts</p>
-            </div>
-          </div>
         </div>
       </main>
     </div>

package/templates/frontend/src/components/Navbar.css

@@ -10,12 +10,10 @@
   z-index: 100;
 }
 
-/* ── Brand ── */
 .navbar-brand {
   display: flex;
   align-items: center;
   gap: 0.6rem;
-  text-decoration: none;
 }
 
 .navbar-logo {
@@ -30,7 +28,6 @@
   letter-spacing: 0.3px;
 }
 
-/* ── Actions ── */
 .navbar-actions {
   display: flex;
   align-items: center;

package/templates/frontend/src/components/Navbar.jsx

@@ -3,7 +3,7 @@ import { BrowserProvider } from 'ethers';
 import './Navbar.css';
 
 export default function Navbar() {
-  const [account, setAccount]     = useState(null);
+  const [account, setAccount]       = useState(null);
   const [connecting, setConnecting] = useState(false);
 
   async function connectWallet() {

package/templates/scripts/deploy.js

@@ -0,0 +1,18 @@
+const { ethers } = require('hardhat');
+
+async function main() {
+  
+  const [deployer] = await ethers.getSigners();
+  console.log('Deploying from:', deployer.address);
+
+  const MyContract = await ethers.getContractFactory('MyContract');
+  const contract = await MyContract.deploy();
+  await contract.waitForDeployment();
+
+  console.log('MyContract deployed to:', await contract.getAddress());
+}
+
+main().catch((err) => {
+  console.error(err);
+  process.exitCode = 1;
+});

package/templates/scripts/upgrade.js

@@ -0,0 +1,20 @@
+const { ethers, upgrades } = require('hardhat');
+
+// Address of the proxy contract from your initial deployment
+const PROXY_ADDRESS = '0xYOUR_PROXY_ADDRESS_HERE';
+
+async function main() {
+  const [deployer] = await ethers.getSigners();
+  console.log('Upgrading from:', deployer.address);
+
+  const MyContractV2 = await ethers.getContractFactory('MyContractV2');
+  const upgraded = await upgrades.upgradeProxy(PROXY_ADDRESS, MyContractV2);
+  await upgraded.waitForDeployment();
+
+  console.log('Proxy upgraded at:', await upgraded.getAddress());
+}
+
+main().catch((err) => {
+  console.error(err);
+  process.exitCode = 1;
+});

package/templates/test/MyContract.test.js

@@ -0,0 +1,10 @@
+const { expect } = require('chai');
+const { ethers } = require('hardhat');
+
+describe('MyContract', function () {
+  it('should deploy successfully', async function () {
+    const MyContract = await ethers.getContractFactory('MyContract');
+    const contract = await MyContract.deploy();
+    expect(await contract.getAddress()).to.not.equal(ethers.ZeroAddress);
+  });
+});