create-near-app 8.2.0 → 8.4.0

package/dist/app.js

@@ -31,6 +31,7 @@ const semver_1 = __importDefault(require("semver"));
 const make_1 = require("./make");
 const user_input_1 = require("./user-input");
 const show = __importStar(require("./messages"));
+const utils_1 = require("./utils");
 (async function () {
     const supportedNodeVersion = require('../package.json').engines.node;
     if (!semver_1.default.satisfies(process.version, supportedNodeVersion)) {
@@ -54,9 +55,18 @@ const show = __importStar(require("./messages"));
         console.error(e);
         createSuccess = false;
     }
+    let needsToInstallCargoNear = false;
+    if (contract === 'rs') {
+        show.checkingCargoNear();
+        let cargoNearInstalled = await (0, utils_1.isCargoNearInstalled)();
+        if (!cargoNearInstalled) {
+            needsToInstallCargoNear = true;
+            show.cargoNearIsNotInstalled();
+        }
+    }
     if (createSuccess) {
         install && await (0, make_1.runDepsInstall)(projectPath);
-        show.setupSuccess(projectName, contract, frontend, install);
+        show.setupSuccess(projectName, contract, frontend, install, needsToInstallCargoNear);
     }
     else {
         return show.setupFailed();

package/dist/make.js

@@ -27,11 +27,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.runDepsInstall = exports.copyDir = exports.createProject = void 0;
-const show = __importStar(require("./messages"));
 const cross_spawn_1 = __importDefault(require("cross-spawn"));
 const fs_1 = __importDefault(require("fs"));
 const ncp_1 = require("ncp");
 const path_1 = __importDefault(require("path"));
+const show = __importStar(require("./messages"));
+const utils_1 = require("./utils");
 async function createProject({ contract, frontend, projectPath, templatesDir }) {
     if (contract !== 'none') {
         await createContract({ contract, projectPath, templatesDir });
@@ -43,11 +44,32 @@ async function createProject({ contract, frontend, projectPath, templatesDir })
 }
 exports.createProject = createProject;
 async function createContract({ contract, projectPath, templatesDir }) {
+    await createContractFromTemplate({ contract, projectPath, templatesDir });
+    if (contract === 'rs') {
+        await updateTemplateFiles(projectPath);
+    }
+}
+async function createContractFromTemplate({ contract, projectPath, templatesDir }) {
     // contract folder
     const sourceContractDir = path_1.default.resolve(templatesDir, 'contracts', contract);
     fs_1.default.mkdirSync(projectPath, { recursive: true });
     await copyDir(sourceContractDir, projectPath);
 }
+async function updateTemplateFiles(projectPath) {
+    const targetDir = path_1.default.join(projectPath);
+    const cargoTomlRemotePath = 'https://raw.githubusercontent.com/near/cargo-near/refs/heads/main/cargo-near/src/commands/new/new-project-template/Cargo.template.toml';
+    const cargoTomlFilePath = path_1.default.join(targetDir, 'Cargo.toml');
+    const rustToolchainRemotePath = 'https://raw.githubusercontent.com/near/cargo-near/refs/heads/main/cargo-near/src/commands/new/new-project-template/rust-toolchain.toml';
+    const rustToolchainFilePath = path_1.default.join(targetDir, 'rust-toolchain.toml');
+    show.updatingFiles();
+    try {
+        await (0, utils_1.downloadFile)(cargoTomlRemotePath, cargoTomlFilePath);
+        await (0, utils_1.downloadFile)(rustToolchainRemotePath, rustToolchainFilePath);
+    }
+    catch (err) {
+        show.updateFilesFailed();
+    }
+}
 async function createGateway({ frontend, projectPath, templatesDir }) {
     const sourceFrontendDir = path_1.default.resolve(`${templatesDir}/frontend/${frontend}`);
     fs_1.default.mkdirSync(projectPath, { recursive: true });

package/dist/messages.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.depsInstallError = exports.depsInstall = exports.creatingApp = exports.directoryExists = exports.windowsWarning = exports.unsupportedNodeVersion = exports.argsError = exports.gatewayInstructions = exports.contractInstructions = exports.setupSuccess = exports.successFrontendToText = exports.successContractToText = exports.setupFailed = exports.welcome = exports.show = void 0;
+exports.cargoNearIsNotInstalled = exports.checkingCargoNear = exports.updateFilesFailed = exports.updatingFiles = exports.depsInstallError = exports.depsInstall = exports.creatingApp = exports.directoryExists = exports.windowsWarning = exports.unsupportedNodeVersion = exports.argsError = exports.gatewayInstructions = exports.contractInstructions = exports.setupSuccess = exports.successFrontendToText = exports.successContractToText = exports.setupFailed = exports.welcome = exports.show = void 0;
 const chalk_1 = __importDefault(require("chalk"));
 const tracking_1 = require("./tracking");
 if (process.env.NEAR_NO_COLOR) {
@@ -24,9 +24,21 @@ Please refer to https://github.com/near/create-near-app README to troubleshoot.
 Notice: some platforms aren't supported (yet).
 {bold {red ==========================================}}`);
 exports.setupFailed = setupFailed;
+const mapContractLanguage = (contract) => {
+    switch (contract) {
+        case 'ts':
+            return 'Typescript';
+        case 'rs':
+            return 'Rust';
+        case 'py':
+            return 'Python';
+        default:
+            return '';
+    }
+};
 const successContractToText = (contract) => contract === 'none'
     ? ''
-    : (0, chalk_1.default) `a smart contract in {bold ${contract === 'rs' ? 'Rust' : 'Typescript'}}`;
+    : (0, chalk_1.default) `a smart contract in {bold ${mapContractLanguage(contract)}}`;
 exports.successContractToText = successContractToText;
 const frontendTemplates = {
     'next-page': 'NextJS (Classic)',
@@ -37,34 +49,52 @@ const successFrontendToText = (frontend) => frontend === 'none'
     ? ''
     : (0, chalk_1.default) `a web-app using ${frontendTemplates[frontend]}`;
 exports.successFrontendToText = successFrontendToText;
-const setupSuccess = (projectName, contract, frontend, install) => (0, exports.show)((0, chalk_1.default) `
-{green ======================================================}
-✅  Success! Created '${projectName}', ${(0, exports.successContractToText)(contract)}${(0, exports.successFrontendToText)(frontend)}.
+const setupSuccess = (projectName, contract, frontend, install, needsToInstallCargoNear) => (0, exports.show)((0, chalk_1.default) `
+✅ Success! Created '${projectName}', ${(0, exports.successContractToText)(contract)}${(0, exports.successFrontendToText)(frontend)}.
 ${contract === 'rs'
     ? (0, chalk_1.default) `🦀 If you are new to Rust please visit {bold {green https://www.rust-lang.org }}\n`
     : ''}
 {bold {bgYellow {black Next steps}}}:
-${(0, exports.contractInstructions)(projectName, contract, install)}${(0, exports.gatewayInstructions)(projectName, frontend, install)}`);
+${(0, exports.contractInstructions)(projectName, contract, install, needsToInstallCargoNear)}${(0, exports.gatewayInstructions)(projectName, frontend, install)}`);
 exports.setupSuccess = setupSuccess;
-const contractInstructions = (projectName, contract, install) => contract === 'none'
-    ? ''
-    : (0, chalk_1.default) `
-   - {inverse Navigate to your project}:
-         {blue cd {bold ${projectName}}}
-${contract === 'ts' && !install
-        ? (0, chalk_1.default) `   - {inverse Install all dependencies}
-         {blue npm {bold install}}`
-        : 'Then:'}
-   - {inverse Build your contract}:
-         ${contract === 'ts'
-        ? (0, chalk_1.default) `{blue npm {bold run build}}`
-        : (0, chalk_1.default) `{blue {bold cargo near build}}`}
-   - {inverse Test your contract} in the Sandbox:
-         ${contract === 'ts'
-        ? (0, chalk_1.default) `{blue npm {bold run test}}`
-        : (0, chalk_1.default) `{blue {bold cargo test}}`}
-   
-🧠 Read {bold {greenBright README.md}} to explore further`;
+const contractInstructions = (projectName, contract, install, needsToInstallCargoNear) => {
+    if (contract === 'none') {
+        return '';
+    }
+    let message = '';
+    if (needsToInstallCargoNear) {
+        message += (0, chalk_1.default) `   - {inverse Install cargo-near}:
+         {blue Go to {bold https://github.com/near/cargo-near}}\n`;
+    }
+    message += (0, chalk_1.default) `   - {inverse Navigate to your project}:
+         {blue cd {bold ${projectName}}}\n`;
+    if (contract === 'ts' && !install) {
+        message += (0, chalk_1.default) `   - {inverse Install all dependencies}
+         {blue npm {bold install}}\n`;
+    }
+    message += (0, chalk_1.default) `   - {inverse Build your contract}:\n`;
+    if (contract === 'ts') {
+        message += (0, chalk_1.default) `         {blue npm {bold run build}}\n`;
+    }
+    else if (contract === 'py') {
+        message += (0, chalk_1.default) `         {blue {bold uvx nearc contract.py --create-venv}}\n`;
+    }
+    else {
+        message += (0, chalk_1.default) `         {blue {bold cargo near build}}\n`;
+    }
+    message += (0, chalk_1.default) `   - {inverse Test your contract} in the Sandbox:\n`;
+    if (contract === 'ts') {
+        message += (0, chalk_1.default) `         {blue npm {bold run test}}\n`;
+    }
+    else if (contract === 'py') {
+        message += (0, chalk_1.default) `         {blue {bold uv run pytest}}\n`;
+    }
+    else {
+        message += (0, chalk_1.default) `         {blue {bold cargo near test}}\n`;
+    }
+    message += (0, chalk_1.default) `\n🧠 Read {bold {greenBright README.md}} to explore further`;
+    return message;
+};
 exports.contractInstructions = contractInstructions;
 const gatewayInstructions = (projectName, frontend, install) => frontend === 'none'
     ? ''
@@ -91,12 +121,21 @@ const windowsWarning = () => (0, exports.show)((0, chalk_1.default) `{red Please
 exports.windowsWarning = windowsWarning;
 const directoryExists = (dirName) => (0, exports.show)((0, chalk_1.default) `{red This directory already exists! ${dirName}}`);
 exports.directoryExists = directoryExists;
-const creatingApp = () => (0, exports.show)((0, chalk_1.default) `\nCreating a new {bold NEAR dApp}`);
+const creatingApp = () => (0, exports.show)((0, chalk_1.default) `\n- Creating a new {bold NEAR dApp}...`);
 exports.creatingApp = creatingApp;
-const depsInstall = () => (0, exports.show)((0, chalk_1.default) `
-{green Installing dependencies in a few folders, this might take a while.}
-`);
+// Installing dependencies messages
+const depsInstall = () => (0, exports.show)((0, chalk_1.default) `- Installing dependencies in a few folders, this might take a while...`);
 exports.depsInstall = depsInstall;
 const depsInstallError = () => (0, exports.show)(chalk_1.default.red('Error installing NEAR project dependencies'));
 exports.depsInstallError = depsInstallError;
+// Updating files messages
+const updatingFiles = () => (0, exports.show)((0, chalk_1.default) `- Updating Cargo.toml and rust-toolchain.toml files from the remote source...`);
+exports.updatingFiles = updatingFiles;
+const updateFilesFailed = () => (0, exports.show)((0, chalk_1.default) `  {yellow There was a problem during the Cargo.toml and rust-toolchain.toml files remote updating. Check your internet connection.}\n`);
+exports.updateFilesFailed = updateFilesFailed;
+// Checking cargo-near messages
+const checkingCargoNear = () => (0, exports.show)((0, chalk_1.default) `- Checking if cargo-near extension is installed...`);
+exports.checkingCargoNear = checkingCargoNear;
+const cargoNearIsNotInstalled = () => (0, exports.show)((0, chalk_1.default) `  {bold {yellow Did not find cargo-near, please install it to build and deploy Rust contracts: https://github.com/near/cargo-near}}`);
+exports.cargoNearIsNotInstalled = cargoNearIsNotInstalled;
 //# sourceMappingURL=messages.js.map

package/dist/tracking.js

@@ -45,7 +45,7 @@ const trackUsage = async (frontend, contract) => {
         });
     }
     catch (e) {
-        console.error('Warning: problem while sending tracking data. Error: ', e);
+        console.error('  Warning: problem while sending tracking data\n');
     }
 };
 exports.trackUsage = trackUsage;

package/dist/types.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.APPS = exports.FRONTENDS = exports.CONTRACTS = void 0;
-exports.CONTRACTS = ['ts', 'rs', 'none'];
+exports.CONTRACTS = ['ts', 'rs', 'py', 'none'];
 exports.FRONTENDS = ['next-app', 'next-page', 'vite-react', 'none'];
 exports.APPS = ['contract', 'gateway'];
 //# sourceMappingURL=types.js.map

package/dist/user-input.js

@@ -57,6 +57,7 @@ const appChoices = [
 const contractChoices = [
     { title: 'JS/TS Contract', description: 'A Near contract written in javascript/typescript', value: 'ts' },
     { title: 'Rust Contract', description: 'A Near contract written in Rust', value: 'rs' },
+    { title: 'Python Contract', description: 'A Near contract written in Python', value: 'py' },
 ];
 const frontendChoices = [
     { title: 'NextJs (Classic)', description: 'A web-app built using Next.js Page Router', value: 'next-page' },

package/dist/utils/checkCargoNear.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const { execSync } = require('child_process');
+function isCargoNearInstalled() {
+    try {
+        // execute but hide output
+        execSync('cargo near --version', { stdio: 'ignore' });
+        return true;
+    }
+    catch (error) {
+        return false;
+    }
+}
+exports.default = isCargoNearInstalled;
+//# sourceMappingURL=checkCargoNear.js.map

package/dist/utils/donwloadFile.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const https_1 = __importDefault(require("https"));
+const fs_1 = __importDefault(require("fs"));
+const stream_1 = require("stream");
+const util_1 = require("util");
+const streamPipeline = (0, util_1.promisify)(stream_1.pipeline);
+async function downloadFile(url, destination) {
+    return new Promise((resolve, reject) => {
+        https_1.default.get(url, (response) => {
+            if (response.statusCode !== 200) {
+                reject(new Error(`Downloading failed: ${response.statusCode}`));
+                return;
+            }
+            streamPipeline(response, fs_1.default.createWriteStream(destination))
+                .then(resolve)
+                .catch(reject);
+        }).on('error', reject);
+    });
+}
+exports.default = downloadFile;
+//# sourceMappingURL=donwloadFile.js.map

package/dist/utils/index.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCargoNearInstalled = exports.downloadFile = void 0;
+const donwloadFile_1 = __importDefault(require("./donwloadFile"));
+exports.downloadFile = donwloadFile_1.default;
+const checkCargoNear_1 = __importDefault(require("./checkCargoNear"));
+exports.isCargoNearInstalled = checkCargoNear_1.default;
+//# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-near-app",
-  "version": "8.2.0",
+  "version": "8.4.0",
   "description": "Quickly scaffold your dApp on NEAR Blockchain",
   "main": "index.js",
   "engines": {

package/templates/contracts/py/.python-version

@@ -0,0 +1 @@
+3.13

package/templates/contracts/py/README.md

@@ -0,0 +1,74 @@
+# contract-py
+
+cargo-near-new-project-description
+
+## How to Build Locally?
+
+Install Python and Emscripten:
+
+```bash
+# Install Python (if not already installed)
+# Use your system's package manager or download from https://www.python.org/downloads/
+
+# Install Emscripten (required for compiling Python contracts to WebAssembly)
+# For Linux/macOS:
+git clone https://github.com/emscripten-core/emsdk.git
+cd emsdk
+./emsdk install latest
+./emsdk activate latest
+source ./emsdk_env.sh
+# Add to your .bashrc or .zshrc for permanent installation:
+# echo 'source "/path/to/emsdk/emsdk_env.sh"' >> ~/.bashrc
+cd ..
+
+# For Windows:
+# Download and extract: https://github.com/emscripten-core/emsdk
+# Then in Command Prompt:
+# cd emsdk
+# emsdk install latest
+# emsdk activate latest
+# emsdk_env.bat
+
+# Verify installation with:
+emcc --version
+
+# Install uv for Python package management
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# Install NEAR CLI-RS to deploy and interact with the contract
+curl --proto '=https' --tlsv1.2 -LsSf https://github.com/near/near-cli-rs/releases/latest/download/near-cli-rs-installer.sh | sh
+```
+
+Then run:
+
+```bash
+uvx nearc greeting_contract.py
+```
+
+## How to Test Locally?
+
+```bash
+uv run pytest
+```
+
+## How to Deploy?
+
+To deploy manually, install [`cargo-near`](https://github.com/near/cargo-near) and run:
+
+```bash
+# Create a new account
+cargo near create-dev-account
+
+# Deploy the contract on it
+cargo near deploy <account-id>
+```
+## Useful Links
+
+- [cargo-near](https://github.com/near/cargo-near) - NEAR smart contract development toolkit for Rust
+- [near CLI](https://near.cli.rs) - Iteract with NEAR blockchain from command line
+- [NEAR Python SDK Documentation](https://github.com/r-near/near-sdk-py)
+- [NEAR Documentation](https://docs.near.org)
+- [NEAR StackOverflow](https://stackoverflow.com/questions/tagged/nearprotocol)
+- [NEAR Discord](https://near.chat)
+- [NEAR Telegram Developers Community Group](https://t.me/neardev)
+- NEAR DevHub: [Telegram](https://t.me/neardevhub), [Twitter](https://twitter.com/neardevhub)

package/templates/contracts/py/contract.py

@@ -0,0 +1,31 @@
+from near_sdk_py import Contract, view, call, init
+
+class GreetingContract(Contract):
+    """
+    A simple greeting contract that stores and returns a message.
+    """
+    
+    @init
+    def initialize(self, default_message="Hello, NEAR world!"):
+        """
+        Initialize the contract with a default greeting message.
+        """
+        self.storage["greeting"] = default_message
+        return {"success": True}
+    
+    @call
+    def set_greeting(self, message: str):
+        """
+        Change the greeting message.
+        """
+        self.storage["greeting"] = message
+        self.log_info(f"Saving greeting: {message}")
+        return {"success": True}
+    
+    @view
+    def get_greeting(self):
+        """
+        Retrieve the current greeting message.
+        """
+        return self.storage.get("greeting", "Hello, NEAR world!")
+        

package/templates/contracts/py/pyproject.toml

@@ -0,0 +1,10 @@
+[project]
+name = "py-near"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "near-pytest>=0.7.1",
+    "near-sdk-py>=0.7.3",
+]

package/templates/contracts/py/tests/test_mod.py

@@ -0,0 +1,53 @@
+from near_pytest.testing import NearTestCase
+import json
+
+class TestGreetingContract(NearTestCase):
+    @classmethod
+    def setup_class(cls):
+        """Compile and deploy the greeting contract."""
+        super().setup_class()
+        
+        # Compile the contract
+        wasm_path = cls.compile_contract(
+            "contract.py",
+            single_file=True
+        )
+        
+        # Deploy the contract
+        cls.contract_account = cls.create_account("contract")
+        cls.instance = cls.deploy_contract(cls.contract_account, wasm_path)
+        
+        # Initialize the contract
+        cls.instance.call_as(
+            account=cls.contract_account,
+            method_name="initialize",
+            args={"default_message": "Initial greeting"},
+        )
+        
+        # Create test user
+        cls.user = cls.create_account("user")
+        
+        # Save state for future resets
+        cls.save_state()
+    
+    def setup_method(self):
+        """Reset state before each test method."""
+        self.reset_state()
+        
+    def test_greeting(self):
+        # Set greeting as user
+        result = self.instance.call_as(
+            account=self.user,
+            method_name="set_greeting",
+            args={"message": "Hello from test!"}
+        )
+        result = json.loads(result.text)
+        assert result["success"] == True
+        
+        # Get greeting
+        greeting = self.instance.call_as(
+            account=self.user,
+            method_name="get_greeting"
+        )
+        assert greeting.text == "Hello from test!"
+