@0x/assert

v3.0.36

Provides a standard way of performing type and schema validation across 0x projects For more information about how to use this package see README

Latest version published 2 years ago

License: Apache-2.0

NPM

GitHub

Package Health Score

61 / 100

security
Security review needed
popularity
Small
maintenance
Inactive
community
Active

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
3.0.36	\|	04/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.1.6	\|	09/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.23	\|	01/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

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

Small

Weekly Downloads (3,880)

GitHub Stars: 97
Forks: 64
Contributors: 90

Direct Usage Popularity

The npm package @0x/assert receives a total of 3,880 downloads a week. As such, we scored @0x/assert popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package @0x/assert, we found that it has been starred 97 times.

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

Community

Active

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

With more than 10 contributors for the @0x/assert repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 2
Open PR: 8
Last Release: 2 years ago
Last Commit: 1 month ago

Further analysis of the maintenance status of @0x/assert based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for @0x/assert is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

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: >=6.12

Age: 6 years
Dependencies: 6 Direct
Versions: 70
Install Size: 43.1 kB
Dist-tags: 2
# of Files: 9
Maintainers: 9
TS Typings: Yes

@0x/assert 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.

Not sure how to use @0x/assert?

To help you get started, we've collected the most common ways that @0x/assert is being used within popular public projects.

0xProject / 0x-monorepo / packages / abi-gen-wrappers / src / generated-wrappers / i_asset_proxy.ts View on Github

awaitTransactionSuccessAsync(
            assetData: string,
            from: string,
            to: string,
            amount: BigNumber,
            txData?: Partial,
            opts: AwaitTransactionSuccessOpts = { shouldValidate: true },
        ): PromiseWithTransactionHash {
            assert.isString('assetData', assetData);
            assert.isString('from', from);
            assert.isString('to', to);
            assert.isBigNumber('amount', amount);
            const self = (this as any) as IAssetProxyContract;
            const txHashPromise = self.transferFrom.sendTransactionAsync(
                assetData,
                from.toLowerCase(),
                to.toLowerCase(),
                amount,
                txData,
                opts,
            );
            return new PromiseWithTransactionHash(
                txHashPromise,
                (async (): Promise =&gt; {
                    // When the transaction hash resolves, wait for it to be mined.
                    return self._web3Wrapper.awaitTransactionSuccessAsync(

View more ways to use @0x/assert

@0x/assert

Standard type and schema assertions to be used across all 0x projects and packages

Installation

yarn add @0x/assert

Usage

import { assert } from '@0x/assert';

assert.isValidBaseUnitAmount('baseUnitAmount', baseUnitAmount);

If your project is in TypeScript, add the following to your tsconfig.json:

"compilerOptions": {
    "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
}

Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our contribution guidelines before getting started.

Install dependencies

If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:

yarn config set workspaces-experimental true

Then install dependencies

yarn install

Build

To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:

PKG=@0x/assert yarn build

Or continuously rebuild on change:

PKG=@0x/assert yarn watch

Clean

yarn clean

Lint

yarn lint

Run Tests

yarn test

@0x/assert dependencies

lodash @0x/utils valid-url @types/node @0x/json-schemas @0x/typescript-typings

@0x/assert development dependencies

nyc shx chai mocha tslint dirty-chai typescript npm-run-all @types/mocha @types/lodash @types/valid-url @0x/tslint-config make-promises-safe

FAQs

What is @0x/assert?

Provides a standard way of performing type and schema validation across 0x projects. Visit Snyk Advisor to see a full health score report for @0x/assert, including popularity, security, maintenance & community analysis.

Is @0x/assert popular?

The npm package @0x/assert receives a total of 3,880 weekly downloads. As such, @0x/assert popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @0x/assert well maintained?

We found indications that @0x/assert is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is @0x/assert safe to use?

While scanning the latest version of @0x/assert, 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 17 November-2024, at 12:23 (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

Package Health Score

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (3,880)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Not sure how to use @0x/assert?

@0x/assert

Installation

Usage

Contributing

Install dependencies

Build

Clean

Lint

Run Tests

@0x/assert dependencies

@0x/assert development dependencies

FAQs

What is @0x/assert?

Is @0x/assert popular?

Is @0x/assert well maintained?

Is @0x/assert safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues