simplehold
TypeScript icon, indicating that this package has built-in type declarations

1.2.1 • Public • Published

simplehold

SDK for SimpleHold Extension Wallet

Go to

Install

yarn:

yarn add simplehold

npm:

npm install simplehold

Check is installed

const isInstalled = await SimpleHoldSDK.isInstalled()

Create select address button

This method will draw a button on the site that the user can click to select the address

SimpleHoldSDK.init({
  buttonId: 'my-button',
  inputId: 'my-input',
  size: 'small', // small or large
  isRound?: true, // Optional make the button round - true or false
  withTooltip?: true // Optional (true/false) show tooltip text
});

Create send button

This method will draw a button on the site that the user can click to send funds

SimpleHoldSDK.createSendButton({
  buttonId: 'my-send-button',
  size: 'small', // small or large
  recipientAddress: 'address',
  currency: 'btc', // Use getCurrencies() method for getting all supported addresses
  amount: '0.1',
  readOnly: false,
  chain: undefined // Optional
});

Example

The example below was written for react app

import * as React from 'react'
import * as SimpleHoldSDK from 'simplehold'

const Example: React.FC = () => {
  const [address, setAddress] = React.useState<string>('')

  React.useEffect(() => {
    document.addEventListener(
      'sh-select-address',
      (data) => {
        const {
          detail: { address },
        } = data

        setAddress(address)
      },
      false
    )

    return () => {
      document.removeEventListener(
        'sh-select-address',
        (data) => {
          const {
            detail: { address },
          } = data

          setAddress(address)
        },
        false
      )
    }
  }, [])

  return (
    <div>
      <div id="my-button" />
      <input
        id="my-input"
        value={address}
        onChange={(e: React.ChangeEvent<HTMLInputElement>) => setAddress(e.target.value)}
      />
    </div>
  )
}

export default Example

Get supported currencies

const currencies = SimpleHoldSDK.getCurrencies()

Currency data:

{
	symbol: string;
	background: string;
	type: 'currency' | 'token';
	chain?: 'eth' | 'bsc';
	logo: string;
}

Set currency

SimpleHoldSDK.setCurrency(currency, chain);

Remove currency

SimpleHoldSDK.removeCurrency();

Readme

Keywords

none

Package Sidebar

Install

npm i simplehold

Weekly Downloads

44

Version

1.2.1

License

MIT

Unpacked Size

155 kB

Total Files

12

Last publish

Collaborators

  • lukas-ss