commons

Common utilities, modules and configurations used in API3 projects.

The commons library is meant to stop "reinventing the wheel". It holds the canonical implementations that can be imported in other packages. This way we ensure that all package use the same logic, simplify bug fixes and avoid code duplication. The package is cross platform and can be used in Node.js and browser.

The commons library is a collection of multiple modules, with each module having its own README that you can refer to.

Getting started

# Feel free to use your favorite package manager
pnpm i @api3/commons

Read the documentation and sources of each module how to use it in the project.

Modules

• blockchain-utilities
• config-hash
• config-parsing
• http
• logger
• processing
• promise-utils
• release-scripts
• run-in-loop
• utils

Using the package in universal context

Some modules may be used only in both browser and Node.js context and some are Node.js only. To support this requirement, we use different entrypoints for each context. Note, there is no support for browser-only modules.

The bundler or Node.js picks up the right entrypoint automatically, but bear in mind that only a subset of modules is available when using universal modules. If you use TypeScript, it may not pick up the correct types. You can set these manually, by adding the following to your tsconfig.json:

"compilerOptions": {
  "paths": {
    "@api3/commons": ["./node_modules/@api3/commons/dist/esm/universal-index.d.ts"]
  }
}

ESM and CommonJS

The package ships both module systems. dist/esm holds the ES modules and dist/cjs holds the CommonJS modules. Both come with type declarations. The bundler or Node.js picks the right one through the exports field, so import and require both work without any configuration on your side.

Related repositories

• chains
• contracts
• eslint-plugin-commons
• ois

For developers

Please refer to the developer instructions for details.