@zondax/izari-filecoin-tools v0.1.0-rc1

Izari Filecoin Tools

Short description

• It is written in Typescript
• It is composed by pure JS
• It is transpiled to two different flavours:
  • CommonJS (es2015)
  • ESM (esnext)

Requisites

• NodeJS >= 16.0.0

React

• In order to use this package in browsers (like react, react-native, etc), some modules need to be polyfill (like Buffer, stream, etc). Most projects use webpack to bundle JS code. If your project uses it, please refer to this doc in order to configure it correctly. Besides, you could check this blog post too.

Features

Filecoin Node Comms

Addresses

Transactions

Wallet

Development

Build

In order to install all required dependencies, just need to run the following command

yarn install

Then, if you want to build the package, just need to run the following command. It will build both CJS and ESM flavours.

yarn build

Testing

The repo has established a set of rules to run ESLint in order to catch typos and possible bugs as soon as possible.

yarn lint

Besides the linter, a formatter is set in place to assure the same code style through our developers.

yarn format

Test cases generated automatically and are written in json files. Those files are consumed by jest to create on case for each scenario. In order to create those files from a raw input file, just run the following command.

yarn test:generate

Finally, in order to run tests, just do it by simply running the next command.

yarn test

Notes

• Please, there are some env vars you need to set first in order to run the tests. Check it first.

Tests

So far, the package has been tested in different environments. We are trying to assure it works in as many platforms as we can.

Environments

Web Browsers

Notes

Jest

• It was necessary to load ESM support on jest in order to be able to load some modules that has no support to CJS anymore. In particular, @ipld/dag-cbor is the one that forced us to do it. It was done following the jest documentation site.
• According to the ts-jest documentation site, we are using a custom tsconfig.json file.
• TypeScript allows importing other TypeScript files with a .js extension, for compatibility with the ES6 modules loader specification. Unfortunately, Jest gets confused by this and complains that it's not able to find the JavaScript file. jest-ts-webcompat-resolver is the actual resolver we use in order to be able to handle imports with extensions. More info here.
• In order to generate test cases for addresses features, we are using a glif package called @glif/filecoin-address. Besides, generating transaction test cases is done by using zondax package called @zondax/filecoin-signing-tools

React

• React app is based on create-react-app utility. It has been ejected in order to configure webpack to polyfill some NodeJS native modules. In particular, you can find the custom configs added here and here.

https://jestjs.io/docs/ecmascript-modules