@wert-io/module-react-component
TypeScript icon, indicating that this package has built-in type declarations

2.1.1 • Public • Published

Wert Module React component

This is the wrapped Wert widget-initializer helper for React projects.

Installation

yarn add @wert-io/module-react-component

or

npm install @wert-io/module-react-component

Usage example

import { useState } from 'React';
import { useWertWidget } from '@wert-io/module-react-component';
import type { GeneralOptions, ReactiveOptions } from '@wert-io/module-react-component';

export default function WertWidgetButton () {
    const options: GeneralOptions = {
        partner_id: 'YOUR_PARTNER_ID',
        // ...
    };
    const [reactiveOptions, setReactiveOptions] = useState<ReactiveOptions>({
        theme: 'dark',
        listeners: {
            'loaded': () => console.log(loaded),
        },
    });

    const { open: openWertWidget, isWidgetOpen } = useWertWidget(reactiveOptions);

    return <button
        onClick={() => {
            openWertWidget({ options });
            console.log(isWidgetOpen);
        }}
    >
        Make A Purchase
    </button>
}

Options

The useWertWidget function expects a single optional argument - an object with reactive options (listeners and theme-related parameters).

You should pass all static options (including optional smart contract related ones) to the open method. The open method expects an object of the following type:

interface StaticOptions {
  options: GeneralOptions;
  smartContractOptions?: SmartContractOptions;
}

You can find the full list of the options that can be passed to the widget here.

Adding smart contract options

We've added @wert-io/widget-sc-signer to simplify the data signing process for executing smart contracts. Just pass the smartContractOptions object to the open function with the following options:

Field Name Data Type Required
address string required
commodity string required
commodity_amount number required
network string required
sc_address string required
sc_input_data string required
private_key string required
import { useWertWidget } from '@wert-io/module-react-component';
import type { GeneralOptions, SmartContractOptions } from '@wert-io/module-react-component';

// ...

const options: GeneralOptions = {
    partner_id: 'YOUR_PARTNER_ID',
};
const smartContractOptions: SmartContractOptions = {
    address: 'FALLBACK_ADDRESS',
    commodity: 'ETH',
    network: 'goerli',
    commodity_amount: 0.005,
    sc_address: 'SMART_CONTRACT_ADDRESS',
    sc_input_data: 'SMART_CONTRACT_EXECUTION_DATA',
    private_key: 'YOUR_PRIVATE_KEY', // We advise you not to store the private key on the frontend
}
const { open } = useWertWidget();

const openWidget = () => open({ options, smartContractOptions });

You can find more information on how the signer works and its' options here.

Readme

Keywords

none

Package Sidebar

Install

npm i @wert-io/module-react-component

Weekly Downloads

877

Version

2.1.1

License

ISC

Unpacked Size

26 kB

Total Files

8

Last publish

Collaborators

  • victoriafilileeva
  • kense1
  • alex-wert
  • apples-father-wert