Class BGL

BGL <- WBGL, swap BGL and recive WBGL to your bitgesell address,

Constructors

constructor

Properties

bglRpcNode bglWallet bridgeEndpoint chainName privateKey web3 minTxFee

Methods

_broadcastbglTransaction _buildBridgeTransactionObject _fetchAddressUTxos _getBglAddressBalance _post _submitToBridge swapBGLforWBGL

Constructors

constructor

Properties

Private bglRpcNode

bglRpcNode: string

Bitgesell RPC Node to interact with

Private bglWallet

bglWallet: BGLWallet

an Instance of Bitgesell Wallet to use Signs transactions to approve and transfer BGL to the Bridge in exchange for WBGL

Link

Read More: https://bglswap.com/

Private bridgeEndpoint

bridgeEndpoint: string

Current Bridge Endpoint: https://bglswap.com/app/

Link

https://bglswap.com/

Private chainName

chainName: string

Chain Names for Network to interract with: BSC, Ethereum, Note: Arbitrum and Optimism (L2s) are not supported yet.

Private Readonly privateKey

privateKey: string

BGL Wallet PrivateKey to use for sigining transactions

Private web3

web3: Web3<RegisteredSubscription>

Web3 instance to use for Interacting with WBGL contract on BSC, Ethereum, and L2 chains(coming soon)

Static Private minTxFee

minTxFee: number = ...

Minimum Fee in satoshi units for BGL transaction

Methods

Private _broadcastbglTransaction

  • _broadcastbglTransaction(txObject): Promise<any>

  • Parameters

    • txObject: Record<string, string>

      transaction object to broadcast. see implementation of building a txObject

    Returns Promise<any>

    a response from the Bitgesell RPC node.

Private _buildBridgeTransactionObject

  • _buildBridgeTransactionObject(bglFromPublicAddress, bglAmountToSwap, bridgeBGLaddress, privateKey, bglTxFee): Promise<any>

  • Parameters

    • bglFromPublicAddress: string
    • bglAmountToSwap: number
    • bridgeBGLaddress: string
    • privateKey: string
    • bglTxFee: number

    Returns Promise<any>

Private _fetchAddressUTxos

  • _fetchAddressUTxos(bglAddress): Promise<any>

  • Parameters

    • bglAddress: string

    Returns Promise<any>

Private _getBglAddressBalance

  • _getBglAddressBalance(bglAddress): Promise<any>

  • Parameters

    • bglAddress: string

    Returns Promise<any>

Private _post

  • _post(endpoint, headers, payload): Promise<any>

  • Parameters

    • endpoint: string
    • headers: Record<string, string>
    • payload: {
          address: string;
          chain: string;
      }
      • address: string
      • chain: string

    Returns Promise<any>

Private _submitToBridge

  • _submitToBridge(receivingAddress, chainName): Promise<IBridgeResponse>

  • Parameters

    • receivingAddress: string
    • chainName: string

    Returns Promise<IBridgeResponse>

swapBGLforWBGL

  • swapBGLforWBGL(__namedParameters): Promise<{
        bglBridgeAddress: string;
        bglTxHash: string;
        currentWBGLBridgeBalance: string;
        msg: string;
        rpcResult: BGlSwapSuccessResult;
    }>

  • Send BGL to recieve WBGL tokens to complete the swap

    Parameters

    Returns Promise<{
        bglBridgeAddress: string;
        bglTxHash: string;
        currentWBGLBridgeBalance: string;
        msg: string;
        rpcResult: BGlSwapSuccessResult;
    }>

    Link

    more https://bglswap.com/

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc