1.0.1 • Published 10 months ago

pontis-bridge-sdk v1.0.1

Weekly downloads
-
License
ISC
Repository
-
Last release
10 months ago

Bridge Asset Operations Documentation

Supported Cross-Chain Assets

  • BTC
  • I•NEED•TEST•RUNES

Actions with Bitcoin Blockchain

useBitcoinBlockchainActions

1. createSendBtc

  • amount: Amount to send
  • feeRate: Fee rate for bridge transaction
  • recipientAddress: Address of the recipient
  • destinationChain: Target chain
  • doSignAndBroadcastPsbt: Function to sign and broadcast the generated PSBT. Returns txId.
  • doSignMessage: Function to sign the bridge message (specific step for the Bitcoin chain).

2. createSendRune

  • rune: Rune to send
  • ...

Actions with Stacks Blockchain

useStxBlockchainActions

  • whitelistedRunes: List of supported runes
  • unlockBtc

    • publicKey: Public key of the signer
    • amount: Amount to transfer
    • recipientAddress: Address of the recipient
    • targetChain: Target chain
    • stacksNetwork: "testnet" | "mainnet"
    • doSignAndBroadcast: Function to sign and broadcast the generated StacksTransaction. Returns txId.
  • unlockRunes

    • ...
    • rune: Rune to send
    • ...

Supported EVM Chains

  • Sepolia (SEP)
  • Merlin (MERL)

EVM Contracts

  • Contracts for Sepolia and Merlin

Actions with EVM Blockchain

useEvmBlockchainActions

  • Approval contract will be called if permission is not granted

1. createBridgeOutBTC

  • amount: Amount to send
  • recipientAddress: Destination address
  • sourceChain: SEP or MERL
  • targetChain: Destination chain
  • serviceValue: Service value

2. createSendRune

  • rune: Rune to send
  • ...

pontisAxiosInstance - axios instance to interact with