Native Coin

Native Coin React Widgets and Modals

Get Method Widgets and Modals

To use the widgets in React components you need to import the Widget component:

import { Widget } from '@paytweed/frontend-sdk-react'

Every widget has an optional parameter called settings.

Name	Type	Default	Description
fullScreen	Boolean	true	Should widget be shown fullscreen
hideMenu	Boolean	true	Deprecated
preventClose	Boolean	true	Hides close button

You can provide them to the widget like this:

<Widget settings={{hideMenu: false}}>

---

Exchange​

Description​

Exchange between native coins (ETH → XTZ for ex.).

Fees will be taken from the source currency.

Parameters​

Name	Type	Required	Default	Description
amount	String	✔️		Amount of source coin to be sent
fromBlockchainId	String	✔️		Source blockchain id
toBlockchainId	String	✔️		Destination blockchain id

Usage Example​

<Widget.Coin.Exchange amount="1.23" fromBlockchainId="ethereum" toBlockchainId="tezos">

---

Send to user​

Description​

Sends a token to another user on the platform by its user ID. The user will get a Sign Transaction widget to approve the transaction.

Parameters​

Name	Type	Required	Description
blockchainId	String	✔️	Blockchain
amount	String	✔️	Amount of crypto
onClose	() => void		Close callback
onError	() => void		Error callback
onSuccess	() => void		Success callback
userId	String	✔️	Id of user to send crypto to

Usage​ Example

const App = () => <Widget.Coin.SendToUser blockchainId='ethereum' amount='1.23' userId='1' />

---

Send to wallet​

Description​

Sends a token to another wallet by its wallet address. The user will get a Sign Transaction widget to approve the transaction.

Parameters​

Name	Type	Required	Description
blockchainId	String	✔️	Blockchain
value	String	✔️	Amount of crypto
onClose	() => void		Close callback
onError	() => void		Error callback
onSuccess	() => void		Success callback
walletAddress	String	✔️	Address of wallet to send crypto to

Usage Example​

const App = () => (
  <Widget.Coin.SendToWallet
    blockchainId='ethereum'
    value='1.23'
    walletAddress='0x15b895d74582daea01be8e5be264243d8c9d7bb1'
  />
)

GET

GET Native Coin Widgets and Modals

To use the widgets in React components you need to import the Widget component:

import { Widget } from '@paytweed/frontend-sdk-react'

Every widget has an optional parameter called settings.

Name	Type	Default	Description
fullScreen	Boolean	true	Should widget be shown fullscreen
hideMenu	Boolean	true	Deprecated
preventClose	Boolean	true	Hides close button

You can provide them to the widget like this:

<Widget settings={{hideMenu: false}}>

---

Exchange​

Description​

Exchange between native coins (ETH → XTZ for ex.).

Fees will be taken from the source currency.

Parameters​

Name	Type	Required	Default	Description
amount	String	✔️		Amount of source coin to be sent
fromBlockchainId	String	✔️		Source blockchain id
toBlockchainId	String	✔️		Destination blockchain id

Usage Example​

<Widget.Coin.Exchange amount="1.23" fromBlockchainId="ethereum" toBlockchainId="tezos">

---

Send to user​

Description​

Sends a token to another user on the platform by its user ID. The user will get a Sign Transaction widget to approve the transaction.

Parameters​

Name	Type	Required	Description
blockchainId	String	✔️	Blockchain
amount	String	✔️	Amount of crypto
onClose	() => void		Close callback
onError	() => void		Error callback
onSuccess	() => void		Success callback
userId	String	✔️	Id of user to send crypto to

Usage​ Example

const App = () => <Widget.Coin.SendToUser blockchainId='ethereum' amount='1.23' userId='1' />

---

Send to wallet​

Description​

Sends a token to another wallet by its wallet address. The user will get a Sign Transaction widget to approve the transaction.

Parameters​

Name	Type	Required	Description
blockchainId	String	✔️	Blockchain
value	String	✔️	Amount of crypto
onClose	() => void		Close callback
onError	() => void		Error callback
onSuccess	() => void		Success callback
walletAddress	String	✔️	Address of wallet to send crypto to

Usage Example​

const App = () => (
  <Widget.Coin.SendToWallet
    blockchainId='ethereum'
    value='1.23'
    walletAddress='0x15b895d74582daea01be8e5be264243d8c9d7bb1'
  />
)

POST

POST Native Coin Widgets and Modals

import { hooks } from '@paytweed/frontend-sdk-react'

Mutation Parameters​

Name	Type	Required	Description
widget parameters	WidgetParameters		Widget parameters

Usage Example​

const [sendCoin] = hooks.useSendCoinToUser({
  callbacks: {
    onSuccess: () => {
      console.log('Success')
    },
    onError: () => {
      console.log('Error')
    },
    settings: {
      preventClose: true,
    },
  },
})

---

Send coin to user​

Description​

Displays a modal for sending coins to a user with a specified address and amount, by using your internal user ID.

Callback Parameters​

Name	Type	Required	Default	Description
blockchainId	String	✔️		Blockchain
value	String	✔️		Amount of crypto
userId	String	✔️		Id of user to send crypto to

Usage​ Example

const [sendCoin] = hooks.useSendCoinToUser()

sendCoin({
  blockchainId: 'ethereum',
  value: '0.1',
  userId: '1',
})

---

Send coin to wallet​

Description​

Show modal for sending coin to address with specified amount.

Callback Parameters​

Name	Type	Required	Default	Description
blockchainId	String	✔️		Blockchain
value	String	✔️		Amount of crypto
walletAddress	String	✔️		Id of user to send crypto to

Usage Example​

const [sendCoin] = hooks.useSendCoinToUser()

sendCoin({
  blockchainId: 'ethereum',
  value: '0.1',
  walletAddress: '1',
})