create-near-app 3.1.0 → 4.0.0-beta.1.0

package/templates/{vanilla → shared}/README.md

@@ -7,44 +7,47 @@ This app was initialized with [create-near-app]
 Quick Start
 ===========
 
-To run this project locally:
+If you haven't installed dependencies during setup:
 
-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`)
+    yarn deps-install
 
-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.
+Build and deploy your contract to TestNet with a temporary dev account:
+
+    yarn deploy
+
+Test your contract tests:
+
+    yarn test
+
+If you have a frontend, run `yarn start`. This will run a dev server.
 
 
 Exploring The Code
 ==================
 
-1. The "backend" code lives in the `/contract` folder. See the README there for
-   more info.
+1. The smart-contract code lives in the `/contract` folder. See the README there for
+   more info. In blockchain apps the smart contract is the "backend" of your app.
 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`.
+   place to start exploring. Note that it loads in `/frontend/index.js`,
+   this is your entrypoint to learn how the frontend connects to the NEAR blockchain.
+3. Test your contract: `yarn test`, this will run the tests in `integration-tests` directory.
 
 
 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.
+Every smart contract in NEAR has its [own associated account][NEAR accounts]. 
+When you run `yarn deploy`, your smart contract gets deployed to the live NEAR TestNet with a temporary dev 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:
+[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 `yarn install`, but for best ergonomics you may want to install it globally:
 
-    npm install --global near-cli
+    yarn global add near-cli
 
 Or, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx`
 
@@ -64,26 +67,22 @@ Each account on NEAR can have at most one contract deployed to it. If you've alr
 
       near create-account near-blank-project.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet
 
+Step 2: deploy the contract
+---------------------------
 
-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'
+Use the CLI to deploy the contract to TestNet with your account ID.
+Replace `PATH_TO_WASM_FILE` with the `wasm` that was generated in `contract` build directory.
 
+    near deploy --accountId near-blank-project.YOUR-NAME.testnet --wasmFile PATH_TO_WASM_FILE
 
-Step 3: deploy!
----------------
 
-One command:
+Step 3: set contract name in your frontend code
+-----------------------------------------------
 
-    npm run deploy
+Modify the line in `src/config.js` that sets the account name of the contract. Set it to the account id you used above.
 
-As you can see in `package.json`, this does two things:
+    const CONTRACT_NAME = process.env.CONTRACT_NAME || 'near-blank-project.YOUR-NAME.testnet'
 
-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

package/templates/{react → shared}/near.gitignore

@@ -10,7 +10,7 @@ node_modules
 /dist
 
 # keys
-/neardev
+/templates/react/neardev
 
 # testing
 /coverage

package/contracts/assemblyscript/as-pect.config.js

@@ -1 +0,0 @@
-module.exports = require('near-sdk-as/imports')

package/contracts/assemblyscript/assembly/__tests__/main.spec.ts

@@ -1,11 +0,0 @@
-import { set_greeting, get_greeting } from '..'
-
-describe('Greeting ', () => {
-  it('should get the default greeting', () => {
-    expect(get_greeting()).toBe('Hello')
-  })
-  it('should change the greeting', () => {
-    set_greeting('howdy')
-    expect(get_greeting()).toBe('howdy')
-  })
-})

package/contracts/assemblyscript/package.json

@@ -1,13 +0,0 @@
-{
-  "name": "greeter",
-  "version": "1.0.0",
-  "license": "UNLICENSED",
-  "private": true,
-  "scripts": {
-    "build": "asb",
-    "test": "asp --nologo"
-  },
-  "dependencies": {
-    "near-sdk-as": "^3.2.3"
-  }
-}

package/integration-tests/js/package.json

@@ -1,16 +0,0 @@
-{
-  "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

@@ -1,31 +0,0 @@
-
-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

@@ -1,32 +0,0 @@
-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/integration-tests/ts/package.json

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

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

@@ -1,44 +0,0 @@
-import { Worker, NEAR, NearAccount } from 'near-workspaces'
-import anyTest, { TestFn } from 'ava'
-
-const test = anyTest as TestFn<{
-  worker: Worker;
-  accounts: Record<string, NearAccount>;
-}>
-
-test.beforeEach(async (t) => {
-  // Init the worker and start a Sandbox server
-  const worker = await Worker.init()
-
-  // deploy contract
-  const root = worker.rootAccount
-  const contract = await root.createAndDeploy(
-    root.getSubAccount('greeter').accountId,
-    './out/main.wasm',
-    { initialBalance: NEAR.parse('30 N').toJSON() }
-  )
-
-  // Save state for test runs, it is unique for each test
-  t.context.worker = worker
-  t.context.accounts = { root, contract }
-})
-
-test.afterEach(async (t) => {
-  // Stop Sandbox server
-  await t.context.worker.tearDown().catch((error) => {
-    console.log('Failed to stop the Sandbox:', error)
-  })
-})
-
-test('returns the default greeting', async (t) => {
-  const { contract } = t.context.accounts
-  const message: string = await contract.view('get_greeting', {})
-  t.is(message, 'Hello')
-})
-
-test('changes the message', async (t) => {
-  const { root, contract } = t.context.accounts
-  await root.call(contract, 'set_greeting', { message: 'Howdy' })
-  const message: string = await contract.view('get_greeting', {})
-  t.is(message, 'Howdy')
-})

package/templates/none/.gitattributes

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

package/templates/none/README.md

@@ -1,101 +0,0 @@
-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

@@ -1,27 +0,0 @@
-# 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

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

package/templates/none/package.json

@@ -1,33 +0,0 @@
-{
-  "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/.gitpod.yml

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

package/templates/react/README.md

@@ -1,102 +0,0 @@
-near-blank-project
-==================
-
-This [React] 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/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.
-
-
-  [React]: https://reactjs.org/
-  [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/react/ava.config.cjs

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