PkgFoundry
Catalog npm
Back to packageRELEASE DETAILS

0.0.0-20220427161307

npm

0xsequence

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

Published27 Apr 2022
Direct dependencies22
Transitive dependenciesNot calculated

README

Current package documentation

0xsequence

Install

npm install 0xsequence ethers

or

pnpm install 0xsequence ethers

or

yarn add 0xsequence ethers

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 pnpm 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 pnpm test, or you can boot up the Typescript compiling server (pnpm test:server) and ethereum test node (pnpm start:hardhat and pnpm 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. pnpm test:server -- in one terminal, to start the webpack server compiling typescript
  2. pnpm start:hardhat -- in a second terminal, to start hardhat local ethereum test node
  3. pnpm 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. pnpm test:only window-transport.

From CLI

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

pnpm 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 22

Native requirements
22 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
ethers
Environment
{
  "local_name": "ethers",
  "alias": false,
  "peer_metadata": null
}
^5.5.2runtime
@0xsequence/abi
Environment
{
  "local_name": "@0xsequence/abi",
  "alias": false,
  "peer_metadata": null
}
^0.0.0-20220427161307runtime
@0xsequence/api
Environment
{
  "local_name": "@0xsequence/api",
  "alias": false,
  "peer_metadata": null
}
^0.0.0-20220427161307runtime
@0xsequence/auth
Environment
{
  "local_name": "@0xsequence/auth",
  "alias": false,
  "peer_metadata": null
}
^0.0.0-20220427161307runtime
@0xsequence/guard
Environment
{
  "local_name": "@0xsequence/guard",
  "alias": false,
  "peer_metadata": null
}
^0.0.0-20220427161307runtime
@0xsequence/utils
Environment
{
  "local_name": "@0xsequence/utils",
  "alias": false,
  "peer_metadata": null
}
^0.0.0-20220427161307runtime
@0xsequence/config
Environment
{
  "local_name": "@0xsequence/config",
  "alias": false,
  "peer_metadata": null
}
^0.0.0-20220427161307runtime
@0xsequence/wallet
Environment
{
  "local_name": "@0xsequence/wallet",
  "alias": false,
  "peer_metadata": null
}
^0.0.0-20220427161307runtime
@0xsequence/indexer
Environment
{
  "local_name": "@0xsequence/indexer",
  "alias": false,
  "peer_metadata": null
}
^0.0.0-20220427161307runtime
@0xsequence/network
Environment
{
  "local_name": "@0xsequence/network",
  "alias": false,
  "peer_metadata": null
}
^0.0.0-20220427161307runtime
@0xsequence/relayer
Environment
{
  "local_name": "@0xsequence/relayer",
  "alias": false,
  "peer_metadata": null
}
^0.0.0-20220427161307runtime
@0xsequence/metadata
Environment
{
  "local_name": "@0xsequence/metadata",
  "alias": false,
  "peer_metadata": null
}
^0.0.0-20220427161307runtime
@0xsequence/provider
Environment
{
  "local_name": "@0xsequence/provider",
  "alias": false,
  "peer_metadata": null
}
^0.0.0-20220427161307runtime
@0xsequence/multicall
Environment
{
  "local_name": "@0xsequence/multicall",
  "alias": false,
  "peer_metadata": null
}
^0.0.0-20220427161307runtime
@0xsequence/transactions
Environment
{
  "local_name": "@0xsequence/transactions",
  "alias": false,
  "peer_metadata": null
}
^0.0.0-20220427161307runtime
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": "ad12cf945123000895dc94647a1cd0b4ccb53716",
  "tarball": "https://registry.npmjs.org/0xsequence/-/0xsequence-0.0.0-20220427161307.tgz",
  "fileCount": 39,
  "integrity": "sha512-pgylwh+aPBOBnOoTFNPUJM7M5Wq3Z6TFdy6IPNVI51FYYJI92FPCLoEC7ifX0jIZbqJWdSr1oWmSqch6nelLKA==",
  "signatures": [
    {
      "sig": "MEYCIQDv4BdxuR2KQa1900iRPyO+7yNO2nWdxMbKifh9igTmhwIhAPd/yLgmmVzcwaOA/veGLiTHWWsU3sXad+kA4roPSOGw",
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"
    }
  ],
  "unpackedSize": 2669207,
  "npm-signature": "-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiaWwBACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmp0wA/9EOXmZODxkSP/Sl0XXia8UP3lGMVYXhPhJTgpT/jGbr8T6jIs\r\nGimBSlIkxs4IPwh8sSpX/Qq7tmo0rj+y2058K+BuMqAFhwu0Nfd1sl/d/VM8\r\nvcoL8W6o9kk+iALBB1yV6RJFzgzgGCR1Bs1iECfJESyBP0nSIF+RyU1WjhCO\r\nTEaw4iN+5zseyDlt0evdYwgsOSbNe67oaK+UTM/UzjIcKzKvt+FeBkDGOKES\r\nMLar8imIJN+NG1839IA/WKQynpF+kFDyrqEHu4xdLt7Qyx86hBWJP1K8F32i\r\nCCGULhf/9TMx0rzVKAQGJw0cGGGcEmoq77GrFk3LRaAC5DMdhv3U9s7aDVBu\r\nWdgpnl7WGzqf3zCJvBQOQsRuBs1T2oQGuc6vK4eyuFOQllRnVR8BIXwZyOG8\r\nfAfpcUoMv8UJ6mQ1U9CwGRToS4N5ycgYqyzKTRn9RCF2kFnXQxGwImMmIBsR\r\nBHEsHaoyYcnFoN3UsVK7MiBESs1sHX73cAkfS6cGaHJyNh2GvWim4C/Rc/X3\r\nvakh2e7Q8f4OdUuq7NDsUZO+JBGbcsL5WVYxSvhgH6hZGc8gr6CEaELTB6GU\r\nqvIgvznNQ2bHlrYfqQXshPiI1I3iL1KYDh4vDq1thq0XP14QqhFeBnGzkdoR\r\ntCJ/DX5KB7Z8XkVQt4cNGtT5aWzQwYjOoHI=\r\n=DcZP\r\n-----END PGP SIGNATURE-----\r\n"
}

Repository

PENDING
0xsequence/sequence.js

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 17:52 UTC

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

Record identity

package_version:291eedef1f6703cfdacdbb73ac847ee39358abf76f80098deda61f83ab2d8e4a

Other collected versions

2.3.472 Oct2.3.4618 Sept2.3.4517 Sept2.3.442 Jun2.3.4324 Mar2.3.4223 MarView all collected versions →