PkgFoundry
Catalog npm
Back to packageRELEASE DETAILS

1.24.0

npm

0xsodium

Sodium: simple & powerful Ethereum development library and Web-based smart wallet

Published20 Jul 2023
Direct dependencies18
Transitive dependenciesNot calculated

README

Current package documentation

0xsequence

Install

yarn add 0xsequence

Development Workflow

Sequence is a critical piece of software and any change should be delivered via a TDD (test-driven development) workflow.

As well, sequence.js's monorepo tooling is setup with preconstruct, which links all sub-packages together so it feels like a single program and is easy to work with. Please run yarn dev in the root of sequence.js/ folder to ensure the monorepo is in 'dev-mode'.

Second, you can run the test suite directly from console with a single yarn test, or you can boot up the Typescript compiling server (yarn test:server) and ethereum test node (yarn start:hardhat and yarn start:hardhat2) manually in separate terminals, and then run a specific test directly from your browser instance. We recommend running the test stack separately and running specific browser tests manually during development. See here for recommended setup.

Running E2E Tests

This 0xsequence top-level package contains e2e tests which run in a headless chrome browser.

You can view tests running directly from the browser directly, or from the cli which will communicate to the headless browser behind the scenes. See below. Please note, for an improved development workflow we highly recommend to view your tests running from the browser as its more clear and better experience.

From Browser

  1. yarn test:server -- in one terminal, to start the webpack server compiling typescript
  2. yarn start:hardhat -- in a second terminal, to start hardhat local ethereum test node
  3. yarn start:hardhat2 -- (2nd chain) in a third terminal, to start hardhat2 local ethereum test node
  4. open browser to http://localhost:9999/{browser-test-dir}/{test-filename}.test.html for example, http://localhost:9999/wallet-provider/dapp.test.html
  5. open your browser console so you can see the tests running and their results.

Finally, if you'd like to run only a specific test case, either add a temporary "return" statement following the last test case, so you will preempt the runner after a certain test case.

As well, since you have all the services running in terminals, you can also execute commands via the cli by calling test:run, which is similar to step 4 above, but executing all tests from the terminal. There is also the test:only command if you'd like to execute a specific test from ./tests/browser/*.spec.ts file, ie. yarn test:only window-transport.

From CLI

With a single command, you can spin up the testing stack and execute tests:

yarn test

This is useful for a sanity check to ensure tests pass, or using it with the CI. However, if you're developing on sequence.js, its highly recommended you follow the development workflow instructions.

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 18

Native requirements
18 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
ethers
Environment
{
  "local_name": "ethers",
  "alias": false,
  "peer_metadata": null
}
^5.7.0runtime
@0xsodium/abi
Environment
{
  "local_name": "@0xsodium/abi",
  "alias": false,
  "peer_metadata": null
}
^1.25.0runtime
@0xsodium/auth
Environment
{
  "local_name": "@0xsodium/auth",
  "alias": false,
  "peer_metadata": null
}
^1.25.0runtime
@0xsodium/guard
Environment
{
  "local_name": "@0xsodium/guard",
  "alias": false,
  "peer_metadata": null
}
^1.17.0runtime
@0xsodium/utils
Environment
{
  "local_name": "@0xsodium/utils",
  "alias": false,
  "peer_metadata": null
}
^1.25.0runtime
@0xsodium/config
Environment
{
  "local_name": "@0xsodium/config",
  "alias": false,
  "peer_metadata": null
}
^1.25.0runtime
@0xsodium/wallet
Environment
{
  "local_name": "@0xsodium/wallet",
  "alias": false,
  "peer_metadata": null
}
^1.25.0runtime
@0xsodium/network
Environment
{
  "local_name": "@0xsodium/network",
  "alias": false,
  "peer_metadata": null
}
^1.25.0runtime
@0xsodium/provider
Environment
{
  "local_name": "@0xsodium/provider",
  "alias": false,
  "peer_metadata": null
}
^1.25.0runtime
@0xsodium/multicall
Environment
{
  "local_name": "@0xsodium/multicall",
  "alias": false,
  "peer_metadata": null
}
^1.25.0runtime
@0xsodium/transactions
Environment
{
  "local_name": "@0xsodium/transactions",
  "alias": false,
  "peer_metadata": null
}
^1.25.0runtime
hardhat
Environment
{
  "local_name": "hardhat",
  "alias": false,
  "peer_metadata": null
}
2.1.2development
webpack
Environment
{
  "local_name": "webpack",
  "alias": false,
  "peer_metadata": null
}
^5.65.0development
webpack-cli
Environment
{
  "local_name": "webpack-cli",
  "alias": false,
  "peer_metadata": null
}
^4.6.0development
babel-loader
Environment
{
  "local_name": "babel-loader",
  "alias": false,
  "peer_metadata": null
}
^8.2.3development
webpack-dev-server
Environment
{
  "local_name": "webpack-dev-server",
  "alias": false,
  "peer_metadata": null
}
^3.11.2development
html-webpack-plugin
Environment
{
  "local_name": "html-webpack-plugin",
  "alias": false,
  "peer_metadata": null
}
^5.3.1development
@babel/plugin-transform-runtime
Environment
{
  "local_name": "@babel/plugin-transform-runtime",
  "alias": false,
  "peer_metadata": null
}
^7.16.10development

Distribution files

1 collected
Distribution 1

Source distribution

Source file
Checksums from source
{
  "shasum": "fc91985542e0b63161a9873439042cfa187bc046",
  "tarball": "https://registry.npmjs.org/0xsodium/-/0xsodium-1.24.0.tgz",
  "fileCount": 30,
  "integrity": "sha512-HdmZhoYg2U/ZdqUOEfkM5TsJZfFz/RKEC/54PxH4Rpi/TfQeGITyotTpv6iBRK2mUNwAAR86RonHLQuD05U1fg==",
  "signatures": [
    {
      "sig": "MEYCIQDFzTe8KZIw07QRoDOW0IRiSGOvEUxVcXuqRd5h5BQiawIhAOzBYwRK8J9YxjihBzI+hJut83SxIOYJC7XZcTrFq1r3",
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"
    }
  ],
  "unpackedSize": 40645
}

Repository

PENDING
sodiumlabs/sodium.js

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 17:54 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:32c640eaaffbb5dc2826cb58209e3ea8464ce650ad689b32fbea9c1a33a90059

Other collected versions

1.48.011 Jun1.47.012 Dec1.46.011 Dec1.45.027 Oct1.44.021 Oct1.43.04 SeptView all collected versions →