Ethereum Provider

You can interact with EVM-based blockchains using Ethers.js or Web3.js together with the Wepin Provider.

Supported Networks

Is the blockchain you need not listed? Please contact the Wepin team for blockchain support.

Chain IDNetwork NameNetwork Variable

1

Ethereum Mainnet

ethereum

5

Ethereum Goerli Testnet

evmeth-goerli

8217

Klaytn Mainnet

klaytn

1001

Klaytn Testnet

klaytn-testnet

19

Songbird Canary Network

evmsongbird

137

Polygon Mainnet

evmpolygon

248

Oasys

evmoasys-games

34

XPLA Mainnet

evmxpla

7300

XPLA Verse Mainnet

evmxpla-verse

2731

TimeNetwork Testnet

evmtime-elizabeth

11155111

Ethereum Sepolia Testnet

evmeth-sepolia

80002

Polygon Amoy Testnet

evmpolygon-amoy

9372

Oasys Testnet

evmoasys-games-testnet

47

XPLA Testnet

evmxpla-testnet

2225

XPLA Verse Testnet

evmxpla-verse-testnet

204

opBNB Mainnet

evmopbnb

56

Binance Smart Chain

evmbsc

Installation

npm install @wepin/provider-js

Once the installation is complete, initialize the WepinProvider instance using the app ID and app key assigned after registering the app. This will enable the use of WepinProvider.

// 1. Import the package
import { WepinProvider } from '@wepin/provider-js'

// 2. Initialization
const WepinProvider = new WepinProvider({
    appId: 'your-wepin-app-id',
    appKey: 'your-wepin-api-key',
})

Initialization

Here's how to initialize the Wepin Provider.

init

await wepinProvider.init(attributes?)

Parameters

  • attributes <object> optional

    • defaultLanguage: The language to be displayed on the widget (default: 'ko') Currently, only 'ko' and 'en' are supported.

    • defaultCurrency: The currency to be displayed on the widget (default: 'KRW') Currently, only 'KRW' and 'USD' are supported.

Return value

  • Promise<void>

Example

await wepinProvider.init({
    defaultLanguage: 'ko',
    defaultCurrency: 'KRW',
})

isInitialized

It checks if WepinProvider is initialized properly.

wepinProvider.isInitialized()

Parameters

  • <void>

Return value

  • <boolean> Returns true if init was successful, otherwise returns false.

Example

if(wepinProvider.isInitialized()) {
  console.log('wepinProvider is initialized!')
}

changeLanguage

It allows changing the language and currency of the widget.

wepinProvider.changeLanguage(attributes)

Parameters

  • attributes <object>

    • language <string> It specifies the language to be displayed on the widget. Currently supported languages are en and ko.

    • currency <string> It specifies the currency to be displayed on the widget. Currently supported currencies are USD and KRW.

Return value

  • <boolean> It returns true if the change was successful, otherwise returns false.

Example

if(wepinProvider.isInitialized()) {
  console.log('wepinProvider is initialized!')
}

Methods

Methods can be used after initializing the Wepin Provider.

getProvider

It returns the provider for the specified network.

await wepinProvider.getProvider(network)

Parameters

Return value

  • Promise<BaseProvider> - A EIP-1193 provider

Example

const provider = await wepinProvider.getProvider('ethereum')

finalize

It terminates the use of WepinProvider.

wepinProvider.finalize()

Parameters

  • <void>

Return value

  • <void>

Example

wepinProvider.finalize()

For more details on EVM-compatible network providers, please refer to the link below.

Last updated