0.2.4 • Published 6 months ago

bitnovo-sdk v0.2.4

Weekly downloads
-
License
-
Repository
-
Last release
6 months ago

Bitnovo SDK

Installation

You can use any package manager:

npm i bitnovo-sdk
pnpm i bitnovo-sdk
yarn add bitnovo-sdk

React Integration

import { BitnovoRamp } from 'bitnovo-sdk'
<BitnovoRamp config={{ apiKey: '' }} />

React + Typescript

import { BitnovoRamp, BitnovoRampProps } from 'bitnovo-sdk'

interface MyOwnBitnovoRampProps extends BitnovoRampProps {}

const MyOwnBitnovoRamp: React.FC<MyOwnBitnovoRampProps> = ({ ...props }) => {
  return <BitnovoRamp {...props} />
}

<MyOwnBitnovoRamp config={{ apiKey: '' }} />

Vanilla Integration

Javascript:

import { initBitnovoRamp } from 'bitnovo-sdk'

initBitnovoRamp({
  config: { apiKey: 'B2X2gbgpOrdaw16yV2ZKD' },
  selector: '#bitnovo-ramp',
  height: '660px',
  width: '420px'
})

HTML:

<div id="bitnovo-ramp" />

Any JS Framework Integration (Svelte, PReact, SolidJs)

import { initBitnovoRamp } from 'bitnovo-sdk'

// Any function that runs only once upon rendering or mounting a component.
  useEffect(() => {
    initBitnovoRamp({
      config: { apiKey: 'B2X2gbgpOrdaw16yV2ZKD' },
      selector: '#bitnovo-ramp',
      height: '660px',
      width: '420px'
    })
  }, [])

//HTML required to be rendered within the component.
<div id="bitnovo-ramp" />

Parameters

URL Parameters

PropertyDescriptionExample
defaultCryptoDefault cryptocurrency to load the widget"USDT_POLYGON,USDC_ETHEREUM"
excludeCryptosParameter to exclude specific cryptocurrencies"USDT_POLYGON,USDC_ETHEREUM"
onlyCryptosSelect specific cryptocurrencies to display"USDT_POLYGON,USDC_ETHEREUM"
excludeCryptoNetworksSelect cryptocurrency networks to exclude"POLYGON,ETHEREUM"
onlyCryptoNetworksSelect specific cryptocurrency networks to display"POLYGON,ETHEREUM"
walletsWallet addresses that can be provided to the widget"BTC:1GDufEqaTG95rnYSydQZVFmVLzMbWkZ7bk,USDT_POLYGON:0xb794f5ea0ba39494ce839613fffba74279579268"
networkWalletsNetwork-specific wallet addresses that can be provided to the widget"POLYGON:0xb794f5ea0ba39494ce839613fffba74279579268,ETHEREUM:0xb794f5ea0ba39494ce839613fffba74279579268"
isAddressEditableParameter to prevent the end user from editing the wallet addresstrue/false
isAmountEditableParameter to prevent the end user from changing the amounttrue/false
apiKeyAPI key created from the developer panelB2X2gbgpOrdaw16yV2ZKD

SDK Parameters

If the SDK is used, all parameters have their respective typing, and it is not necessary to write them as if they were query parameters, for example:

{
    apiKey: 'B2X2gbgpOrdaw16yV2ZKD',
    excludeCryptos: ['USDT_TRON', 'USDC_ETHEREUM'],
    wallets: ['BTC:1GDufEqaTG95rnYSydQZVFmVLzMbWkZ7bk']
}
0.2.4

6 months ago

0.2.3

6 months ago

0.2.2

6 months ago

0.2.1

6 months ago

0.2.0

6 months ago

0.1.8

6 months ago

0.1.7

6 months ago

0.1.6

6 months ago

0.1.5

6 months ago

0.1.4

6 months ago

0.1.3

6 months ago

0.1.2

6 months ago

0.1.1

6 months ago