Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@signumjs/wallets

signum-network112Apache-2.02.0.7TypeScript support: included

Wallets communication package for DApps in the Signum Network

signum, signum-network, blockchain, smartcontracts, crypto, cryptography, cryptocoin, signumjs, dapps, web3, metamask

readme

@signumjs/wallets

This package is for DApp Developers who need to interact/communicate with the wallets of the Signum blockchain platform It provides currently two modes of interaction:

  • Deeplinking
    • One-way communication
    • Desktop and Mobile Wallets
  • Browser Extension Intercom
    • Two-way communication
    • Browser-only Wallets

Installation

@signumjs/wallets can be used with NodeJS or Web. Two formats are available

Using with NodeJS and/or modern web frameworks

Install using npm:

npm install @signumjs/wallets

or using yarn:

yarn add @signumjs/wallets

Example

// TO DO

Using in classic <script>

Each package is available as bundled standalone library using UMD. This way signumJS can be used also within <script>-Tags. This might be useful for Wordpress and/or other PHP applications.

Just import the package using the HTML <script> tag.

<script src='https://cdn.jsdelivr.net/npm/@signumjs/http/dist/signumjs.wallets.min.js'></script>

Example

// TO DO

See more here:

@signumjs/wallets Online Documentation

changelog

Change Log

2.0.7

Patch Changes

2.0.6

Patch Changes

2.0.5

Patch Changes

2.0.4

Patch Changes

2.0.3

Patch Changes

  • Decoupled Crypto Provider. Breaking Change as this requires the developer to define the platform specific crypto provider before using the sdk

    Breaking Change:

    If you see the following error:

    "No Crypto Provider provided - Use [Crypto.init()] first";

    You need to initialize the crypto module with the platform specific CryptoProvider.

    NodeJS

    import { Crypto, NodeJSCryptoProvider } from "@signumjs/crypto";
    Crypto.init(new NodeJSCryptoProvider());

    Web/Browser

    import { Crypto, WebCryptoProvider } from "@signumjs/crypto";
    Crypto.init(new WebCryptoProvider());

    Further implementations will be provided as external modules/packages, i.e. React Native Expo

  • Updated dependencies

2.0.2

Patch Changes

2.0.1

Patch Changes

2.0.0

Major Changes

  • 14f4944: This new version uses a completely modernized stack (turborepo, vite, vitest). Furthermore, the crypto package was rewritten to remove deprecated crypto-js library and being extensible. The standards (SRC) packages were reorganized and finally the monitor package was removed

    Breaking Changes:

    1. @signumjs/monitor was removed, as not really used
    2. @signumjs/crypto was completely rewritten, mainly due to the deprecation of crypto-js and certain security implications
    3. @signumjs/standards were reorganized respecting the Signum Request for Comment (SRC) numbering

    How to update from 1.0 to 2.0

    1. Monitor was removed

    Drop signumjs/monitor (no replacement here) - if you used the monitor you can copy the code from the repo and include it manually in your code base

    1. Adjust Crypto

    2. Passphrase generator was dropped, use generateMnemonic instead

    3. generateMasterKeys was renamed to generateSignKeys
    4. hashSHA256 was renamed to sha256AsHex (and more sha256 hashers are available)
    5. encryptAES and decryptAES were dropped - use native crypto methods for AES encryption. Signum uses for their P2P encryption a AES based algorithm using the shared key (encryptMessage and encryptData)

    The new crypto package offers more secure random and sha256 functions and is much more flexible. Check the docs for more info

    1. Using SRC based standards

    Actually, not much to do here. It's just that the internal structure is organized by the SRC numbering.

Patch Changes

1.0.0

  • Introduced wallets package