chore: improve offramp types (#598)

* chore: improve gateway class typings

* chore: merge abi parts

Author: slavastartsev

sdk/src/gateway/abi.ts

@@ -38,8 +38,8 @@ export const strategyCaller = [
     },
 ] as const;
 
-export const offrampCreateOrderCaller = [
-    {
+export const offrampCaller = {
+    createOrder: {
         type: 'function',
         name: 'createOrder',
         inputs: [
@@ -84,10 +84,7 @@ export const offrampCreateOrderCaller = [
         outputs: [],
         stateMutability: 'nonpayable',
     },
-] as const;
-
-export const offrampBumpFeeCaller = [
-    {
+    bumpFeeOfExistingOrder: {
         type: 'function',
         name: 'bumpFeeOfExistingOrder',
         inputs: [
@@ -105,10 +102,7 @@ export const offrampBumpFeeCaller = [
         outputs: [],
         stateMutability: 'nonpayable',
     },
-] as const;
-
-export const offrampUnlockFundsCaller = [
-    {
+    unlockFunds: {
         type: 'function',
         name: 'unlockFunds',
         inputs: [
@@ -126,17 +120,7 @@ export const offrampUnlockFundsCaller = [
         outputs: [],
         stateMutability: 'nonpayable',
     },
-] as const;
-
-export const compoundV2CTokenAbi = parseAbi([
-    'function exchangeRateCurrent() external returns (uint256)',
-    'function underlying() external view returns (address)',
-]);
-
-export const aaveV2AtokenAbi = parseAbi(['function UNDERLYING_ASSET_ADDRESS() external view returns (address)']);
-
-export const offrampGetOrderCaller = [
-    {
+    getOfframpOrder: {
         type: 'function',
         name: 'getOfframpOrder',
         inputs: [
@@ -166,6 +150,13 @@ export const offrampGetOrderCaller = [
         ],
         stateMutability: 'view',
     },
-] as const;
+} as const;
+
+export const compoundV2CTokenAbi = parseAbi([
+    'function exchangeRateCurrent() external returns (uint256)',
+    'function underlying() external view returns (address)',
+]);
+
+export const aaveV2AtokenAbi = parseAbi(['function UNDERLYING_ASSET_ADDRESS() external view returns (address)']);
 
 export const claimDelayAbi = parseAbi(['function CLAIM_DELAY() view returns (uint64)']);

sdk/src/gateway/client.ts

@@ -32,14 +32,7 @@ import { createBitcoinPsbt, getAddressInfo } from '../wallet';
 import { SYMBOL_LOOKUP, ADDRESS_LOOKUP, getTokenDecimals } from './tokens';
 import { AddressType, Network } from 'bitcoin-address-validation';
 import { EsploraClient } from '../esplora';
-import {
-    claimDelayAbi,
-    offrampBumpFeeCaller,
-    offrampCreateOrderCaller,
-    offrampGetOrderCaller,
-    offrampUnlockFundsCaller,
-    strategyCaller,
-} from './abi';
+import { claimDelayAbi, offrampCaller, strategyCaller } from './abi';
 import { isAddress, Address, isAddressEqual, createPublicClient, http, PublicClient } from 'viem';
 import * as bitcoin from 'bitcoinjs-lib';
 import { bob, bobSepolia } from 'viem/chains';
@@ -85,7 +78,7 @@ export class GatewayApiClient {
      * @constructor
      * @param chainName The chain name.
      */
-    constructor(chainName: string, options?: { rpcUrl?: string }) {
+    constructor(chainName: 'mainnet' | 'testnet' | 'signet' | 'bob', options?: { rpcUrl?: string }) {
         switch (chainName) {
             case 'mainnet':
             case Chain.BOB:
@@ -345,7 +338,7 @@ export class GatewayApiClient {
 
         return {
             quote: offrampQuote,
-            offrampABI: offrampCreateOrderCaller,
+            offrampABI: offrampCaller['createOrder'],
             offrampFunctionName: 'createOrder' as const,
             offrampArgs: [
                 {
@@ -393,7 +386,7 @@ export class GatewayApiClient {
         const offrampRegistryAddress: Address = await this.fetchOfframpRegistryAddress();
 
         return {
-            offrampABI: offrampBumpFeeCaller,
+            offrampABI: offrampCaller['bumpFeeOfExistingOrder'],
             offrampRegistryAddress: offrampRegistryAddress,
             offrampFunctionName: 'bumpFeeOfExistingOrder' as const,
             offrampArgs: [orderId, newFeeSat],
@@ -426,7 +419,7 @@ export class GatewayApiClient {
         }
 
         return {
-            offrampABI: offrampUnlockFundsCaller,
+            offrampABI: offrampCaller['unlockFunds'],
             offrampRegistryAddress: offrampRegistryAddress,
             offrampFunctionName: 'unlockFunds',
             offrampArgs: [orderId, receiver],
@@ -531,7 +524,7 @@ export class GatewayApiClient {
 
         const order = await publicClient.readContract({
             address: offrampRegistryAddress,
-            abi: offrampGetOrderCaller,
+            abi: [offrampCaller['getOfframpOrder']],
             functionName: 'getOfframpOrder',
             args: [orderId],
         });

sdk/src/gateway/types.ts

@@ -1,6 +1,6 @@
 import type { EsploraClient } from '../esplora';
 import { Address } from 'viem';
-import { offrampBumpFeeCaller, offrampCreateOrderCaller, offrampUnlockFundsCaller, strategyCaller } from './abi';
+import { offrampCaller, strategyCaller } from './abi';
 
 type ChainSlug = string | number;
 type TokenSymbol = string;
@@ -386,7 +386,7 @@ export interface OfframpLiquidity {
 /** @dev Params used for createOrder call on the off-ramp contract */
 export type OfframpCreateOrderParams = {
     quote: OfframpQuote;
-    offrampABI: typeof offrampCreateOrderCaller;
+    offrampABI: (typeof offrampCaller)['createOrder'];
     offrampFunctionName: 'createOrder';
     offrampArgs: [
         {
@@ -408,7 +408,7 @@ export type OfframpCreateOrderParams = {
 
 /** @dev Params used to bump fee for an existing order */
 export type OfframpBumpFeeParams = {
-    offrampABI: typeof offrampBumpFeeCaller;
+    offrampABI: (typeof offrampCaller)['bumpFeeOfExistingOrder'];
     offrampRegistryAddress: Address;
     offrampFunctionName: 'bumpFeeOfExistingOrder';
     /**
@@ -420,7 +420,7 @@ export type OfframpBumpFeeParams = {
 
 /** @dev Params used to unlock funds after order completion or refund */
 export type OfframpUnlockFundsParams = {
-    offrampABI: typeof offrampUnlockFundsCaller;
+    offrampABI: (typeof offrampCaller)['unlockFunds'];
     offrampRegistryAddress: Address;
     offrampFunctionName: 'unlockFunds';
     /**

sdk/test/gateway.test.ts

@@ -34,6 +34,7 @@ describe('Gateway Tests', () => {
 
     it('should reject invalid chain', async () => {
         expect(() => {
+            // @ts-expect-error invalid chain id
             new GatewaySDK('bob-testnet');
         }).toThrowError('Invalid chain');
     });