create-near-app 3.0.0-pre.7.0 → 3.1.0

package/index.js

@@ -14,6 +14,9 @@ ncp.limit = 16
 const rustSetup = require('./utils/rust-setup')
 const mixpanel = require('./utils/tracking')
 
+const type = os.type()
+const arch = os.arch()
+
 const renameFile = async function (oldPath, newPath) {
   return new Promise((resolve, reject) => {
     fs.rename(oldPath, newPath, (err) => {
@@ -54,10 +57,13 @@ function copyDir(source, dest, { skip, veryVerbose } = {}) {
 }
 
 const createProject = async function ({ contract, frontend, projectDir, veryVerbose }) {
-  if (os.platform() === 'win32') {
-    console.log('Sorry, create-near-app is not compatible with Windows. Please consider using Windows Subsystem for Linux.\n')
+  const supports_sandbox = (type === 'Linux' || type === 'Darwin') && arch === 'x64'
+
+  if (!supports_sandbox && contract === 'assemblyscript') {
+    console.log('Sorry, assemblyscript is not supported in your system, use --contract=rust')
     return
   }
+
   // track used options
   mixpanel.track(frontend, contract)
 
@@ -72,19 +78,53 @@ const createProject = async function ({ contract, frontend, projectDir, veryVerb
   await copyDir(sourceTemplateDir, projectDir, { veryVerbose, skip: skip.map(f => path.join(sourceTemplateDir, f)) })
 
   // copy tests
-  const sourceTestDir = __dirname + '/integration-tests'
-  await copyDir(sourceTestDir, `${projectDir}/integration-tests`, { veryVerbose, skip: skip.map(f => path.join(sourceTestDir, f)) })
+  if (supports_sandbox) {
+    // Supports Sandbox
+    const sourceTestDir = __dirname + '/integration-tests'
+    await copyDir(sourceTestDir, `${projectDir}/integration-tests/`, { veryVerbose, skip: skip.map(f => path.join(sourceTestDir, f)) })
+    fs.rmSync(`${projectDir}/integration-tests/js`, {recursive: true})
+  }else{
+    // Others use simple ava testing
+    console.log('Our testing framework (workspaces) is not compatible with your system.\n')
+    console.log('Your project will default to basic JS testing.\n')
+    const sourceTestDir = __dirname + '/integration-tests/js'
+    await copyDir(sourceTestDir, `${projectDir}/integration-tests`, { veryVerbose, skip: skip.map(f => path.join(sourceTestDir, f)) }) 
+
+    await replaceInFiles({
+      files: `${projectDir}/package.json`,
+      from: '"test:integration:ts": "cd integration-tests/ts && npm run test"',
+      to: '"test:integration:ts": "echo not supported"'
+    })
+    await replaceInFiles({
+      files: `${projectDir}/package.json`,
+      from: '"test:integration:rs": "cd integration-tests/rs && cargo run --example integration-tests"',
+      to: '"test:integration:ts": "echo not supported"'
+    })
+    await replaceInFiles({
+      files: `${projectDir}/package.json`,
+      from: '"test:integration": "npm run test:integration:ts && npm run test:integration:rs"',
+      to: '"test:integration": "npm run deploy && cd integration-tests && npm run test"'
+    })
+    await replaceInFiles({
+      files: `${projectDir}/package.json`,
+      from: '"near-workspaces": "^2.0.0",',
+      to: ' '
+    })
+  }
 
   // copy contract files
   const contractSourceDir = `${__dirname}/contracts/${contract}`
   await copyDir(contractSourceDir, `${projectDir}/contract`, { veryVerbose, skip: skip.map(f => path.join(contractSourceDir, f)) })
 
+  // make out dir
+  fs.mkdirSync(`${projectDir}/out`)
+
   // changes in package.json for rust
   if (contract === 'rust') {
     await replaceInFiles({
       files: `${projectDir}/package.json`,
-      from: 'cd contract && npm run build && mkdir -p ../out && rm -f ./out/main.wasm && cp ./build/release/greeter.wasm ../out/main.wasm',
-      to: 'mkdir -p out && cd contract && rustup target add wasm32-unknown-unknown && cargo build --all --target wasm32-unknown-unknown --release && rm -f ./out/main.wasm && cp ./target/wasm32-unknown-unknown/release/greeter.wasm ../out/main.wasm'
+      from: 'cd contract && npm run build && cp ./build/release/greeter.wasm ../out/main.wasm',
+      to: 'cd contract && rustup target add wasm32-unknown-unknown && cargo build --all --target wasm32-unknown-unknown --release && cp ./target/wasm32-unknown-unknown/release/greeter.wasm ../out/main.wasm'
     })
     await replaceInFiles({
       files: `${projectDir}/package.json`,
@@ -108,10 +148,19 @@ const createProject = async function ({ contract, frontend, projectDir, veryVerb
 
   // setup rust
   let wasRustupInstalled = false
-  if (contract === 'rust') {
+  if (contract === 'rust' || supports_sandbox) {
     wasRustupInstalled = await rustSetup.setupRustAndWasm32Target()
   }
 
+  if (contract === 'rust') {
+    // remove assemblyscript
+    await replaceInFiles({
+      files: `${projectDir}/package.json`,
+      from: '"near-sdk-as": "^3.2.3",',
+      to: ' '
+    })
+  }
+
   if (hasNpm || hasYarn) {
     console.log('Installing project dependencies...')
     spawn.sync(hasYarn ? 'yarn' : 'npm', ['install'], { cwd: projectDir, stdio: 'inherit' })
@@ -158,8 +207,8 @@ const opts = yargs
   .example('$0 new-app', 'Create a project called "new-app"')
   .option('frontend', {
     desc: 'template to use',
-    choices: ['vanilla', 'react'],
-    default: 'vanilla',
+    choices: ['vanilla', 'react', 'none'],
+    default: 'react',
   })
   .option('contract', {
     desc: 'language for smart contract',

package/integration-tests/js/ava.config.cjs

@@ -0,0 +1,9 @@
+require("util").inspect.defaultOptions.depth = 5; // Increase AVA's printing depth
+
+module.exports = {
+  timeout: "300000",
+  files: ["src/*.ava.ts"],
+  failWithoutAssertions: false,
+  extensions: ["ts"],
+  require: ["ts-node/register"],
+};

package/integration-tests/js/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "ava-testing",
+  "version": "1.0.0",
+  "license": "(MIT AND Apache-2.0)",
+  "scripts": {
+    "test": "ava --verbose"
+  },
+  "devDependencies": {
+    "ava": "^4.2.0",
+    "near-api-js": "^0.44.2",
+    "typescript": "^4.7.2",
+    "ts-node": "^10.8.0",
+    "@types/bn.js": "^5.1.0"
+  },
+  "dependencies": {}
+}

package/integration-tests/js/src/config.ts

@@ -0,0 +1,31 @@
+
+import { keyStores, KeyPair } from 'near-api-js'
+const fs = require('fs')
+
+const CONTRACT_NAME=fs.readFileSync('../neardev/dev-account', 'utf-8')
+const NETWORK_ID='testnet'
+
+// Create an InMemoryKeyStore
+const keyStore = new keyStores.InMemoryKeyStore()
+
+// Load credentials
+const credPath = `${process.env.HOME}/.near-credentials/${NETWORK_ID}/${CONTRACT_NAME}.json`
+let credentials = JSON.parse(fs.readFileSync(credPath))
+
+// Save key in the key store
+keyStore.setKey(
+  NETWORK_ID,
+  CONTRACT_NAME,
+  KeyPair.fromString(credentials.private_key)
+)
+
+export const nearConfig = {
+  networkId: NETWORK_ID,
+  nodeUrl: 'https://rpc.testnet.near.org',
+  contractName: CONTRACT_NAME,
+  walletUrl: 'https://wallet.testnet.near.org',
+  helperUrl: 'https://helper.testnet.near.org',
+  explorerUrl: 'https://explorer.testnet.near.org',
+  headers: {},
+  deps: {keyStore}
+}

package/integration-tests/js/src/main.ava.ts

@@ -0,0 +1,32 @@
+import anyTest, { TestFn } from 'ava'
+
+import { Near, Account, Contract } from 'near-api-js'
+import { nearConfig } from './config'
+
+const test = anyTest as TestFn<{
+  accounts: Record<string, any>;
+}>
+
+test.beforeEach(async (t) => {
+  const near = await new Near(nearConfig)
+  const user = await new Account(near.connection, nearConfig.contractName)
+  const contract = await new Contract(
+    user,
+    nearConfig.contractName,
+    { viewMethods: ['get_greeting'], changeMethods: ['set_greeting'] }
+  )
+  t.context.accounts = { contract }
+})
+
+test('returns the default greeting', async (t) => {
+  const { contract } = t.context.accounts
+  const message: string = await contract.get_greeting({})
+  t.is(message, 'Hello')
+})
+
+test('changes the message', async (t) => {
+  const { contract } = t.context.accounts
+  await contract.set_greeting({args:{ message: 'Howdy' }})
+  const message: string = await contract.get_greeting({})
+  t.is(message, 'Howdy')
+})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-near-app",
-  "version": "3.0.0-pre.7.0",
+  "version": "3.1.0",
   "description": "generate new near blank project with different type",
   "main": "index.js",
   "files": [

package/templates/none/.gitattributes

@@ -0,0 +1,2 @@
+package-lock.json linguist-generated=true -diff
+yarn.lock linguist-generated=true -diff

package/templates/none/.gitpod.yml

@@ -0,0 +1,6 @@
+tasks:
+  - init: yarn
+    command: yarn dev
+ports:
+  - port: 1234
+    onOpen: open-browser

package/templates/none/README.md

@@ -0,0 +1,101 @@
+near-blank-project
+==================
+
+This app was initialized with [create-near-app]
+
+
+Quick Start
+===========
+
+To run this project locally:
+
+1. Prerequisites: Make sure you've installed [Node.js] ≥ 12
+2. Install dependencies: `npm install`
+3. Run the local development server: `npm run dev` (see `package.json` for a
+   full list of `scripts` you can run with `npm`)
+
+Now you'll have a local development environment backed by the NEAR TestNet!
+
+Go ahead and play with the app and the code. As you make code changes, the app will automatically reload.
+
+
+Exploring The Code
+==================
+
+1. The "backend" code lives in the `/contract` folder. See the README there for
+   more info.
+2. The frontend code lives in the `/frontend` folder. `/frontend/index.html` is a great
+   place to start exploring. Note that it loads in `/frontend/assets/src/js/index.js`, where you
+   can learn how the frontend connects to the NEAR blockchain.
+3. Tests: there are different kinds of tests for the frontend and the smart
+   contract. See `contract/README` for info about how it's tested. The frontend
+   code gets tested with [jest]. You can run both of these at once with `npm
+   run test`.
+
+
+Deploy
+======
+
+Every smart contract in NEAR has its [own associated account][NEAR accounts]. When you run `npm run dev`, your smart contract gets deployed to the live NEAR TestNet with a throwaway account. When you're ready to make it permanent, here's how.
+
+
+Step 0: Install near-cli (optional)
+-------------------------------------
+
+[near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `npm install`, but for best ergonomics you may want to install it globally:
+
+    npm install --global near-cli
+
+Or, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx`
+
+Ensure that it's installed with `near --version` (or `npx near --version`)
+
+
+Step 1: Create an account for the contract
+------------------------------------------
+
+Each account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `near-blank-project.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `near-blank-project.your-name.testnet`:
+
+1. Authorize NEAR CLI, following the commands it gives you:
+
+      near login
+
+2. Create a subaccount (replace `YOUR-NAME` below with your actual account name):
+
+      near create-account near-blank-project.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet
+
+
+Step 2: set contract name in code
+---------------------------------
+
+Modify the line in `src/config.js` that sets the account name of the contract. Set it to the account id you used above.
+
+    const CONTRACT_NAME = process.env.CONTRACT_NAME || 'near-blank-project.YOUR-NAME.testnet'
+
+
+Step 3: deploy!
+---------------
+
+One command:
+
+    npm run deploy
+
+As you can see in `package.json`, this does two things:
+
+1. builds & deploys smart contract to NEAR TestNet
+2. builds & deploys frontend code to GitHub using [gh-pages]. This will only work if the project already has a repository set up on GitHub. Feel free to modify the `deploy` script in `package.json` to deploy elsewhere.
+
+
+Troubleshooting
+===============
+
+On Windows, if you're seeing an error containing `EPERM` it may be related to spaces in your path. Please see [this issue](https://github.com/zkat/npx/issues/209) for more details.
+
+
+  [create-near-app]: https://github.com/near/create-near-app
+  [Node.js]: https://nodejs.org/en/download/package-manager/
+  [jest]: https://jestjs.io/
+  [NEAR accounts]: https://docs.near.org/docs/concepts/account
+  [NEAR Wallet]: https://wallet.testnet.near.org/
+  [near-cli]: https://github.com/near/near-cli
+  [gh-pages]: https://github.com/tschaub/gh-pages

package/templates/none/near.gitignore

@@ -0,0 +1,27 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+# Developer note: near.gitignore will be renamed to .gitignore upon project creation
+# dependencies
+node_modules
+/.pnp
+.pnp.js
+/out
+
+#keys
+/neardev
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

package/templates/none/neardev/shared-test/test.near.json

@@ -0,0 +1 @@
+{"account_id":"test.near","private_key":"ed25519:2wyRcSwSuHtRVmkMCGjPwnzZmQLeXLzLLyED1NDMt4BjnKgQL6tF85yBx6Jr26D2dUNeC716RBoTxntVHsegogYw"}

package/templates/none/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "greeter",
+  "version": "1.0.0",
+  "license": "(MIT AND Apache-2.0)",
+  "scripts": {
+    "build": "npm run build:contract",
+      "build:contract": "cd contract && npm run build && cp ./build/release/greeter.wasm ../out/main.wasm",
+    "deploy": "npm run build:contract && near dev-deploy",
+    "start": "npm run deploy",
+    "dev": "nodemon --watch contract -e ts --exec \"npm run start\"",
+    "test": "npm run build:contract && npm run test:unit && npm run test:integration",
+      "test:unit": "cd contract && npm i && npm run test",
+      "test:integration": "npm run test:integration:ts && npm run test:integration:rs",
+        "test:integration:ts": "cd integration-tests/ts && npm run test",
+        "test:integration:rs": "cd integration-tests/rs && cargo run --example integration-tests"
+  },
+  "devDependencies": {
+    "env-cmd": "^10.1.0",
+    "near-cli": "^3.3.0",
+    "nodemon": "~2.0.16",
+    "parcel": "^2.6.0",
+    "ava": "^4.2.0",
+    "near-workspaces": "^2.0.0",
+    "typescript": "^4.7.2",
+    "process": "^0.11.10",
+    "ts-node": "^10.8.0"
+  },
+  "dependencies": {
+    "near-api-js": "^0.44.2",
+    "near-sdk-as": "^3.2.3",
+    "regenerator-runtime": "~0.13.9"
+  }
+}

package/templates/react/package.json

@@ -4,9 +4,9 @@
   "license": "(MIT AND Apache-2.0)",
   "scripts": {
     "build": "npm run build:contract && npm run build:web",
-      "build:contract": "cd contract && npm run build && mkdir -p ../out && rm -f ./out/main.wasm && cp ./build/release/greeter.wasm ../out/main.wasm",
+      "build:contract": "cd contract && npm run build && cp ./build/release/greeter.wasm ../out/main.wasm",
       "build:web": "parcel build frontend/index.html --public-url ./",
-    "deploy": "npm run build && near dev-deploy",
+    "deploy": "npm run build:contract && near dev-deploy",
     "start": "npm run deploy && echo The app is starting! It will automatically open in your browser when ready && env-cmd -f ./neardev/dev-account.env parcel frontend/index.html --open",
     "dev": "nodemon --watch contract -e ts --exec \"npm run start\"",
     "test": "npm run build:contract && npm run test:unit && npm run test:integration",

package/templates/vanilla/package.json

@@ -4,9 +4,9 @@
   "license": "(MIT AND Apache-2.0)",
   "scripts": {
     "build": "npm run build:contract && npm run build:web",
-      "build:contract": "cd contract && npm run build && mkdir -p ../out && rm -f ./out/main.wasm && cp ./build/release/greeter.wasm ../out/main.wasm",
+      "build:contract": "cd contract && npm run build && cp ./build/release/greeter.wasm ../out/main.wasm",
       "build:web": "parcel build frontend/index.html --public-url ./",
-    "deploy": "npm run build && near dev-deploy",
+    "deploy": "npm run build:contract && near dev-deploy",
     "start": "npm run deploy && echo The app is starting! && env-cmd -f ./neardev/dev-account.env parcel frontend/index.html --open",
     "dev": "nodemon --watch contract -e ts --exec \"npm run start\"",
     "test": "npm run build:contract && npm run test:unit && npm run test:integration",

package/utils/rust-setup.js

@@ -1,4 +1,5 @@
 const chalk = require('chalk')
+const os = require('os')
 const readline = require('readline')
 const sh = require('shelljs')
 
@@ -6,13 +7,14 @@ const sh = require('shelljs')
 const installRustupScript = 'curl --proto \'=https\' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y'
 const updatePath = '. $HOME/.cargo/env'
 const addWasm32TargetScript = 'rustup target add wasm32-unknown-unknown'
-
 // We should update PATH in the same script because every new Bash scripts are executed in a separate shell
 const updatePathAndAddWasm32TargetScript = updatePath + ' && ' + addWasm32TargetScript
 
+const isWindows = os.platform() === 'win32'
+
 function isRustupInstalled() {
   console.log(chalk`Checking if {bold rustup} is installed...`)
-  const isInstalled = sh.exec('rustup --version &> /dev/null').code === 0
+  const isInstalled = sh.exec('rustup --version').code === 0
   console.log(chalk`{bold rustup} is`, isInstalled ? 'installed\n' : 'not installed\n')
   return isInstalled
 }
@@ -69,21 +71,30 @@ const addWasm32TargetDisclaimer = chalk`To build Rust smart contracts you need t
 
 const installRustupQuestion = chalk`
 ${installRustupDisclaimer} We can run the following command to do it for you:
-
     {bold ${installRustupScript}}
-
 Continue with installation (Y/n)?: `
 
 const addWasm32TargetQuestion = chalk`
 ${addWasm32TargetDisclaimer} We can run the following command to do it for you:
-
     {bold ${addWasm32TargetScript}}
-
 Continue with installation (Y/n)?: `
 
+const rustupAndWasm32WindowsInstallationInstructions = chalk`
+${installRustupDisclaimer}
+    1. Go to https://rustup.rs
+    2. Download {bold rustup-init.exe}
+    3. Install it on your system
+${addWasm32TargetDisclaimer}
+Run the following command to do it:
+    {bold ${addWasm32TargetScript}}
+Press {bold Enter} to continue project creation.`
 
 async function setupRustAndWasm32Target() {
   try {
+    if (isWindows) {
+      await askYesNoQuestionAndRunFunction(rustupAndWasm32WindowsInstallationInstructions)
+      return false
+    }
     let wasRustupInstalled = false
     if (!isRustupInstalled()) {
       wasRustupInstalled = await askYesNoQuestionAndRunFunction(installRustupQuestion, installRustup)
@@ -99,4 +110,4 @@ async function setupRustAndWasm32Target() {
 
 module.exports = {
   setupRustAndWasm32Target,
-}
+}