Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
tallyho-onboarding
Advanced tools
This library is used to help onboard new Tally Ho users. It allows you to ask the Tally Ho extension to redirect users back to your page after onboarding has finished.
This library will register the current page as having initiated onboarding, so that Tally Ho knows where to redirect the user after onboarding. Note that the page will be automatically reloaded a single time once a Tally Ho installation is detected, in order to facilitate this registration.
This package was originally used with Metamask's onboarding package
@tallyho-onboarding
is made available as either a CommonJS module, and ES6 module, or an ES5 bundle.
import TallyHoOnboarding from '@tallyho-onboarding'
const TallyHoOnboarding = require('@tallyho-onboarding')
dist/tallyho-onboarding.bundle.js
(this can be included directly in a page)Assuming import TallyHoOnboarding from '@tallyho-onboarding'
, the following API is available.
TallyHoOnboarding.isTallyHoInstalled()
Returns true
if the Tally Ho provider is detected, or false
otherwise.
TallyHoOnboarding.FORWARDER_MODE
A set of constants for each of the available forwarder modes.
Constant | Description |
---|---|
INJECT | Inject a iframe to that will refresh until Tally Ho has installed |
OPEN_TAB | Open a tab to a new page that will refresh until Tally Ho has installed—this is only useful if the client app has disallowed iframes |
new TallyHoOnboarding()
The constructor accepts an optional options bag with the following:
Option | Description |
---|---|
forwarderOrigin | Override the forwarder URL, useful for testing. Optional, defaults to 'https://fwd.metamask.io' . |
forwarderMode | One of the available forwarder modes. Optional, defaults to TallyHoOnboarding.FORWARDER_MODE.INJECT . |
startOnboarding()
Starts onboarding by opening the MetaMask download page and waiting for Tally Ho to be installed. Once the Tally Ho extension installation is detected, a message will be sent to Tally Ho to register the current site as the onboarding initiator.
stopOnboarding()
Stops onboarding registration, including removing the injected iframe
(if any).
nvm use
will automatically choose the right node version for you.yarn setup
to install dependencies and run any requried post-install scripts
yarn
/ yarn install
command directly. Use yarn setup
instead. The normal install command will skip required post-install scripts, leaving your development environment in an invalid state.Run yarn lint
to run the linter.
The project follows the same release process as the other libraries in the Tally Ho organization:
main
1.x
)yarn version --minor --no-git-tag-version
)main
or 1.x
)This project is available under the MIT license.
FAQs
Assists with onboarding new Tally users
The npm package tallyho-onboarding receives a total of 898 weekly downloads. As such, tallyho-onboarding popularity was classified as not popular.
We found that tallyho-onboarding demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.