feat: onramp signet (#520)

nakul1010 · slavastartsev · gregdhill · web-flow · commit f1a1d383c9b2 · 2025-04-23T10:09:22.000+01:00
* fix: add token + esplora and ordinals url * fix: logo url * fix: logo url * fix: change testnet to signnet * fix: change testnet to signnet * chore: bump version * fix: add back testnet urls * fix: add signet url for mempool * fix: build * fix: update comment * fix: estimate the fee test case * fix: test cases * fix: remove double imported types * chore: bump bitcoin-address-validation (#568) Signed-off-by: Gregory Hill <gregorydhill@outlook.com> * chore: fix imports * chore: revert `package.json` formatting --------- Signed-off-by: Gregory Hill <gregorydhill@outlook.com> Co-authored-by: Slava <slava@interlay.io> Co-authored-by: Greg Hill <gregorydhill@outlook.com>
diff --git a/sdk/src/esplora.ts b/sdk/src/esplora.ts
@@ -13,6 +13,11 @@ export const TESTNET_ESPLORA_BASE_PATH = 'https://btc-testnet.gobob.xyz';
  * @default "http://localhost:3003"
  */
 export const REGTEST_ESPLORA_BASE_PATH = 'http://localhost:3003';
+/**
+ * Base path for the signet Esplora API.
+ * @default "https://btc-signet.gobob.xyz"
+ */
+export const SIGNET_ESPLORA_BASE_PATH = 'https://btc-signet.gobob.xyz';
 
 /**
  * @ignore
@@ -170,6 +175,9 @@ export class EsploraClient {
             case 'mainnet':
                 this.basePath = MAINNET_ESPLORA_BASE_PATH;
                 break;
+            case 'signet':
+                this.basePath = SIGNET_ESPLORA_BASE_PATH;
+                break;
             case 'testnet':
                 this.basePath = TESTNET_ESPLORA_BASE_PATH;
                 break;
diff --git a/sdk/src/gateway/client.ts b/sdk/src/gateway/client.ts
@@ -27,9 +27,9 @@ import {
     OfframpOrderStatus,
     EnrichedToken,
 } from './types';
+import { createBitcoinPsbt, getAddressInfo } from '../wallet';
 import { SYMBOL_LOOKUP, ADDRESS_LOOKUP, getTokenDecimals } from './tokens';
-import { createBitcoinPsbt } from '../wallet';
-import { AddressType, getAddressInfo, Network } from 'bitcoin-address-validation';
+import { AddressType, Network } from 'bitcoin-address-validation';
 import { EsploraClient } from '../esplora';
 import {
     claimDelayAbi,
@@ -78,6 +78,7 @@ export class GatewayApiClient {
     private chain: Chain.BOB | Chain.BOB_SEPOLIA;
     private baseUrl: string;
     private strategy: StrategyClient;
+    private isSignet: boolean = false;
 
     /**
      * @constructor
@@ -100,6 +101,7 @@ export class GatewayApiClient {
                 this.chain = Chain.BOB_SEPOLIA; // Same chain as testnet
                 this.baseUrl = SIGNET_GATEWAY_BASE_URL;
                 this.strategy = new StrategyClient(bobSepolia, options?.rpcUrl);
+                this.isSignet = true;
                 break;
             default:
                 throw new Error('Invalid chain');
@@ -294,7 +296,7 @@ export class GatewayApiClient {
             bitcoinNetwork = bitcoin.networks.testnet;
         }
 
-        if (getAddressInfo(params.bitcoinUserAddress).type === AddressType.p2tr) {
+        if (getAddressInfo(params.bitcoinUserAddress, this.isSignet).type === AddressType.p2tr) {
             throw new Error('Only following bitcoin address types are supported P2PKH, P2WPKH, P2SH or P2WSH.');
         }
         const receiverAddress = toHexScriptPubKey(params.bitcoinUserAddress, bitcoinNetwork);
@@ -576,7 +578,8 @@ export class GatewayApiClient {
                 params.fromUserPublicKey,
                 data.opReturnHash,
                 params.feeRate,
-                gatewayQuote.txProofDifficultyFactor
+                gatewayQuote.txProofDifficultyFactor,
+                this.isSignet
             );
         }
 
diff --git a/sdk/src/mempool.ts b/sdk/src/mempool.ts
@@ -1,13 +1,18 @@
 /**
  * Base path for the mainnet Memopool API.
- * @default "https://btc-mainnet.gobob.xyz"
+ * @default "https://mempool.space/api/v1"
  */
 export const MAINNET_MEMPOOL_BASE_PATH = 'https://mempool.space/api/v1';
 /**
  * Base path for the testnet Memopool API.
- * @default "https://btc-testnet.gobob.xyz"
+ * @default "https://mempool.space/testnet4/api/v1"
  */
 export const TESTNET_MEMPOOL_BASE_PATH = 'https://mempool.space/testnet4/api/v1';
+/**
+ * Base path for the signet Memopool API.
+ * @default "https://mempool.space/signet/api/v1"
+ */
+export const SIGNET_MEMPOOL_BASE_PATH = 'https://mempool.space/signet/api/v1';
 /**
  * Base path for the regtest Memopool API.
  * @default "http://localhost:3003"
@@ -49,6 +54,9 @@ export class MempoolClient {
             case 'mainnet':
                 this.basePath = MAINNET_MEMPOOL_BASE_PATH;
                 break;
+            case 'signet':
+                this.basePath = SIGNET_MEMPOOL_BASE_PATH;
+                break;
             case 'testnet':
                 this.basePath = TESTNET_MEMPOOL_BASE_PATH;
                 break;
diff --git a/sdk/src/ordinal-api/index.ts b/sdk/src/ordinal-api/index.ts
@@ -16,6 +16,12 @@ export const MAINNET_ORD_BASE_PATH = 'https://ordinals-mainnet.gobob.xyz';
  */
 export const TESTNET_ORD_BASE_PATH = 'https://ordinals-testnet.gobob.xyz';
 
+/**
+ * Base path for Ordinals signet Explorer.
+ * @default "https://ordinals-signet.gobob.xyz"
+ */
+export const SIGNET_ORD_BASE_PATH = 'https://ordinals-signet.gobob.xyz';
+
 // https://github.com/ordinals/ord/blob/e39031a46531696e5dd0c853146f8bfab5b7582c/src/inscription_id.rs#L4-L7
 export type InscriptionId = {
     txid: string;
@@ -368,6 +374,9 @@ export class OrdinalsClient {
             case 'mainnet':
                 this.basePath = MAINNET_ORD_BASE_PATH;
                 break;
+            case 'signet':
+                this.basePath = SIGNET_ORD_BASE_PATH;
+                break;
             case 'testnet':
                 this.basePath = TESTNET_ORD_BASE_PATH;
                 break;
diff --git a/sdk/src/wallet/utxo.ts b/sdk/src/wallet/utxo.ts
@@ -1,7 +1,7 @@
 import * as bitcoin from 'bitcoinjs-lib';
 import { Transaction, Script, selectUTXO, TEST_NETWORK, NETWORK, p2wpkh, p2sh, p2tr } from '@scure/btc-signer';
 import { hex, base64 } from '@scure/base';
-import { AddressType, getAddressInfo, Network } from 'bitcoin-address-validation';
+import { AddressType, getAddressInfo as getAddressInfoRaw, Network, AddressInfo } from 'bitcoin-address-validation';
 import { EsploraClient, UTXO } from '../esplora';
 import { OrdinalsClient, OutPoint, OutputJson } from '../ordinal-api';
 import { parseInscriptions } from '../inscription';
@@ -19,6 +19,10 @@ export const getBtcNetwork = (name: BitcoinNetworkName) => {
     return bitcoinNetworks[name];
 };
 
+export const getAddressInfo = (address: string, isSignet: boolean): AddressInfo => {
+    return getAddressInfoRaw(address, isSignet ? { castTestnetTo: Network.signet } : undefined);
+};
+
 type Output = { address: string; amount: bigint } | { script: Uint8Array; amount: bigint };
 
 const isCardinalOutput = (output: OutputJson) =>
@@ -101,8 +105,8 @@ const getSafeUtxos = async (
     return findSafeUtxos(utxos, cardinalOutputsSet, esploraClient, ordinalsClient);
 };
 
-const collectPossibleInputs = async (fromAddress: string, publicKey: string) => {
-    const addressInfo = getAddressInfo(fromAddress);
+const collectPossibleInputs = async (fromAddress: string, publicKey: string, isSignet: boolean) => {
+    const addressInfo = getAddressInfo(fromAddress, isSignet);
 
     const esploraClient = new EsploraClient(addressInfo.network);
     const ordinalsClient = new OrdinalsClient(addressInfo.network);
@@ -155,6 +159,7 @@ export interface Input {
  * @param opReturnData Optional OP_RETURN data to include in an output.
  * @param feeRate Optional fee rate in satoshis per byte.
  * @param confirmationTarget The number of blocks to include this tx (for fee estimation).
+ * @param isSignet True if using Bitcoin Signet.
  * @returns {Promise<string>} The Base64 encoded PSBT.
  *
  * @example
@@ -179,9 +184,10 @@ export async function createBitcoinPsbt(
     publicKey?: string,
     opReturnData?: string,
     feeRate?: number,
-    confirmationTarget: number = 3
+    confirmationTarget: number = 3,
+    isSignet: boolean = false
 ): Promise<string> {
-    const addressInfo = getAddressInfo(fromAddress);
+    const addressInfo = getAddressInfo(fromAddress, isSignet);
 
     // TODO: possibly, allow other strategies to be passed to this function
     const utxoSelectionStrategy: 'all' | 'default' = 'default';
@@ -206,7 +212,7 @@ export async function createBitcoinPsbt(
     let possibleInputs: Input[] = [];
     const esploraClient = new EsploraClient(addressInfo.network);
     [possibleInputs, feeRate] = await Promise.all([
-        collectPossibleInputs(fromAddress, publicKey),
+        collectPossibleInputs(fromAddress, publicKey, isSignet),
         feeRate === undefined ? esploraClient.getFeeEstimate(confirmationTarget) : feeRate,
     ]);
 
@@ -321,6 +327,7 @@ export function getInputFromUtxoAndTx(
  * @param opReturnData Optional OP_RETURN data to include in an output.
  * @param feeRate Optional fee rate in satoshis per byte.
  * @param confirmationTarget The number of blocks to include this tx (for fee estimation).
+ * @param isSignet True if using Bitcoin Signet
  * @returns {Promise<bigint>} The fee amount for estimated transaction inclusion in satoshis.
  *
  * @example
@@ -355,9 +362,10 @@ export async function estimateTxFee(
     publicKey?: string,
     opReturnData?: string,
     feeRate?: number,
-    confirmationTarget: number = 3
+    confirmationTarget: number = 3,
+    isSignet: boolean = false
 ): Promise<bigint> {
-    const addressInfo = getAddressInfo(fromAddress);
+    const addressInfo = getAddressInfo(fromAddress, isSignet);
 
     if (addressInfo.network === 'regtest') {
         throw new Error('Bitcoin regtest not supported');
@@ -382,7 +390,7 @@ export async function estimateTxFee(
     let possibleInputs: Input[] = [];
     const esploraClient = new EsploraClient(addressInfo.network);
     [possibleInputs, feeRate] = await Promise.all([
-        collectPossibleInputs(fromAddress, publicKey),
+        collectPossibleInputs(fromAddress, publicKey, isSignet),
         feeRate === undefined ? esploraClient.getFeeEstimate(confirmationTarget) : feeRate,
     ]);
 
@@ -445,6 +453,7 @@ export async function estimateTxFee(
  * @typedef { {confirmed: BigInt, unconfirmed: BigInt, total: bigint} } Balance
  *
  * @param {string} [address] The Bitcoin address. If no address specified returning object will contain zeros.
+ * @param isSignet True if using Bitcoin Signet.
  * @returns {Promise<Balance>} The balance object of provided address in satoshis.
  *
  * @example
@@ -457,12 +466,12 @@ export async function estimateTxFee(
  *
  * @dev UTXOs that contain inscriptions or runes will not be used to calculate balance.
  */
-export async function getBalance(address?: string) {
+export async function getBalance(address?: string, isSignet: boolean = false) {
     if (!address) {
         return { confirmed: BigInt(0), unconfirmed: BigInt(0), total: BigInt(0) };
     }
 
-    const addressInfo = getAddressInfo(address);
+    const addressInfo = getAddressInfo(address, isSignet);
 
     const esploraClient = new EsploraClient(addressInfo.network);
     const ordinalsClient = new OrdinalsClient(addressInfo.network);
