feat: update gateway for v3

[gregdhill]

Closes #314

Example docs:

Install the SDK:

yarn add @gobob/bob-sdk

Create a client:

import { GatewaySDK } from '@gobob/bob-sdk';
 
const gatewaySDK = new GatewaySDK("bob"); // or "bob-sepolia"

Get a quote:

import type { GatewayQuoteParams } from '@gobob/bob-sdk';

const params: GatewayQuoteParams = {
  toChain: 'bob', // Destination chain
  toToken: 'SolvBTC.BBN', // Destination token (e.g. 'wBTC' or 'tBTC')
  toUserAddress: '0x0000', // User's wallet address
  amount: '10000', // Amount to transfer in token decimals
};

const quote = await gatewaySDK.getQuote(params);

Create and update order:

const { uuid, bitcoinAddress, opReturnHash } = await gatewaySDK.startOrder(quote, params);

const bitcoinTx = new bitcoin.Transaction();
// TODO: add inputs / outputs & sign

await gatewaySDK.finalizeOrder(uuid, bitcoinTx.toHex());

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
bob	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 22, 2024 11:52am

[changeset-bot]

⚠️ No Changeset found

Latest commit: a46138a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[derrekcoleman]

This is a BitcoinAddress, right?

[derrekcoleman]

Or long-term, an enum of one or the other

[gregdhill]

Right now this is a copy of the Swing params, we won't do anything with it really

[derrekcoleman]

Okay. As long as it's not going through validation or being included in the hash I suppose it doesn't matter.