Venly Connect SDK

Venly Connect is a javascript SDK specifically designed to perform common blockchain tasks. It is created as a way to perform tasks that are otherwise not possible due to security implications (e.g: creating signatures). Venly Connect wraps all of Venly's functionalities within a JavaScript layer in order to facilitate development.

Documentation on how to use it can be found on below pages:

• Introduction: https://docs.venly.io/docs/widget-overview
• Getting started: https://docs.venly.io/docs/widget-getting-started
• All of Venly's documentation: https://docs.venly.io/

v2 Migration Guide

Installation (changes only for head scripts)

<script src="/node_modules/@venly/connect/umd/index.js"></script>

or when importing from a CDN

<script src="https://unpkg.com/@venly/connect/umd/index.js"></script>

Imports

All types/objects are now imported directly from @venly/connect

import { Wallet } from "@venly/connect";

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

[2.4.0]

Added

• Preload fonts when VenlyConnect is initialized in order to minimize font/layout shifting.

Fixed

• Fix issue with getAccount() always triggering authentication

[2.3.1]

Fixed

• Fix issue with authentication popup staying open during getAccount()

[2.3.0]

Added

• New modals for all actions in VenlyConnect.flows.
  • Users must click on the modal to initiate the popup. This should prevent issues with popup blocking.

[2.0.0]

Added

• Redesign login flow + new UI
• Add options.authenticationOptions.closePopup option. If set to false, Venly popup will be kept open after authenticating.
  • For cases when you need to perform an action immediately after authenticating (such as signing a message)

Changed

• BREAKING: All types/objects are now imported directly from @venly/connect instead of @venly/connect/dist/src
• BREAKING: Change filepath for head script tags
  • To use with npm install: <script src="/node_modules/@venly/connect/umd/index.js"></script>
  • To use directly from a CDN: <script src="https://unpkg.com/@venly/connect/umd/index.js"></script>

Removed

• Fixed

• Fix readContract method to use the correct Content-Type header