near-workspaces

v4.0.0

Write tests in TypeScript/JavaScript to run in a controlled NEAR Sandbox local environment. For more information about how to use this package see README

Latest version published 3 months ago

License: GPL-3.0

NPM

GitHub

Package Health Score

71 / 100

security
Security review needed
popularity
Limited
maintenance
Healthy
community
Sustainable

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
4.0.0	\|	09/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.5.0	\|	01/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.0.0	\|	04/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.0	\|	03/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.0	\|	10/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

GPL-3.0

Non-Permissive License

We noticed that this project uses a license which requires less permissive conditions such as disclosing the source code, stating changes or redistributing the source under the same license. It is advised to further consult the license terms before use.

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (301)

GitHub Stars: 44
Forks: 23
Contributors: 20

Direct Usage Popularity

The npm package near-workspaces receives a total of 301 downloads a week. As such, we scored near-workspaces popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package near-workspaces, we found that it has been starred 44 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 20
Funding: No

With more than 10 contributors for the near-workspaces repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 44
Open PR: 2
Last Release: 3 months ago
Last Commit: 1 month ago

Further analysis of the maintenance status of near-workspaces based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that near-workspaces demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >= 14.0.0

Age: 3 years
Dependencies: 16 Direct
Versions: 16
Install Size: 515 kB
Dist-tags: 2
# of Files: 87
Maintainers: 5
TS Typings: No

near-workspaces has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

NEAR Workspaces (TypeScript/JavaScript Edition)

NEAR Workspaces is a library for automating workflows and writing tests for NEAR smart contracts. You can use it as is or integrate with test runner of your choise (AVA, Jest, Mocha, etc.). If you don't have a preference, we suggest you to use AVA.

Quick Start (without testing frameworks)

To get started with Near Workspaces you need to do only two things:

Initialize a Worker.

const worker = await Worker.init();
const root = worker.rootAccount;

const alice = await root.createSubAccount('alice');
const contract = await root.devDeploy('path/to/compiled.wasm');

Writing tests.

near-workspaces is designed for concurrency. Here's a simple way to get concurrent runs using plain JS:

import {strict as assert} from 'assert';

await Promise.all([
  async () =&gt; {
    await alice.call(
      contract,
      'some_update_function',
      {some_string_argument: 'cool', some_number_argument: 42}
    );
    const result = await contract.view(
      'some_view_function',
      {account_id: alice}
    );
    assert.equal(result, 'whatever');
  },
  async () =&gt; {
    const result = await contract.view(
      'some_view_function',
      {account_id: alice}
    );
    /* Note that we expect the value returned from `some_view_function` to be
    a default here, because this `fork` runs *at the same time* as the
    previous, in a separate local blockchain */
    assert.equal(result, 'some default');
  }
]);

More info in our main README: https://github.com/near/workspaces-js

near-workspaces dependencies

base64url bn.js borsh bs58 callsites fs-extra js-sha256 near-api-js near-sandbox near-units node-port-check promisify-child-process proper-lockfile pure-uuid rimraf temp-dir

near-workspaces development dependencies

@types/bs58 @types/proper-lockfile

FAQs

What is near-workspaces?

Write tests in TypeScript/JavaScript to run in a controlled NEAR Sandbox local environment. Visit Snyk Advisor to see a full health score report for near-workspaces, including popularity, security, maintenance & community analysis.

Is near-workspaces popular?

The npm package near-workspaces receives a total of 301 weekly downloads. As such, near-workspaces popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is near-workspaces well maintained?

We found that near-workspaces demonstrated a healthy version release cadence and project activity. It has a community of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is near-workspaces safe to use?

While scanning the latest version of near-workspaces, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 21 December-2024, at 06:54 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP