@trezor/blockchain-link v2.4.2
@trezor/blockchain-link
blockchain-link is a client and unified interface for several backends (BE further on) of various blockchain networks. Currently, there are implementations for
- blockbook: BE developed and deployed by SatoshiLabs. Provides access to Bitcoin(like) and Ethereum(like) networks.
- ripple: third party BE that provides access to the Ripple network.
- blockfrost: third party BE that provides access to the Cardano network.
Usage
Add blockchain-link to your dependencies.
yarn add @trezor/blockchain-link
And use it.
import BlockchainLink from '@trezor/blockchain-link';
const link = new BlockchainLink({
name: 'Name used in logs.';
worker: 'path/to/the/worker.js';
server: ['url1.of.the.be', 'url2.of.the.be'];
debug: true;
});
try {
const resp = link.getInfo();
} catch(error) {
}
For complete API see the methods of BlockchainLink
class in index.ts.
Workers
Minified workers built for various environments are available in subdirectories of @trezor/blockchain-link/build/
.
module
: Workers wrapped by primitive self-written webpack plugin into javascript module which can be used as regular module on the main thread. Useful in environments whereWorker
API is not available likereact-native
. See this webpack config for example integration.web
: Workers for browser based environments. See this webpack config.node
: Workers for node based environments. See this webpack config.
All workers can be also built from source. For example using webpack worker-loader
:
import BlockbookWorker from 'worker-loader?filename=workers/blockbook-worker.[hash].js!@trezor/blockchain-link/lib/workers/blockbook/index.js';
Development
This package provides a simple testing UI for playing around with various implementations and BEs. Run it with
yarn
yarn dev
Build
yarn lint
yarn test
yarn build
Publishing
Prerequisites
- Make sure you have a npm account with write access to
@trezor/blockchain-link
package. - Update CHANGELOG.md and list all changes since the last release.
- Bump the version in
packages/blockchain-link/package.json
. Use the semver convention.
Production
cd packages/blockchain-link
cd into the root ofblockchain-link
package.yarn build:lib
Build the library.npm publish
Publish!
Beta
If you want to publish to npm as beta
(from any branch) do the following:
cd packages/blockchain-link
cd into the root ofblockchain-link
package.- Change the version in
packages/blockchain-link/package.json
fromX.X.X
toX.X.(X + 1)-beta.1
. The-beta.<n>
suffix is important because NPM registry doesn't allow overriding already published versions. With this suffix we can publish multiple beta versions for a single patch. yarn build:lib
Build the library.npm publish --tag beta
Publish!
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
8 months ago
8 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
11 months ago
11 months ago
11 months ago
11 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago