opnet 1.2.2 → 1.2.3

package/src/abi/shared/interfaces/motoswap/INativeSwapContract.ts

@@ -0,0 +1,267 @@
+import { Address } from '@btc-vision/transaction';
+import { CallResult } from '../../../../contracts/CallResult.js';
+import { IOP_NETContract } from '../opnet/IOP_NETContract.js';
+
+/**
+ * @description Represents the result of the reserve function call.
+ */
+export type ReserveEWMA = CallResult<{
+    reserved: bigint;
+}>;
+
+/**
+ * @description Represents the result of adding liquidity.
+ */
+export type AddLiquidity = CallResult<{
+    ok: boolean;
+}>;
+
+/**
+ * @description Represents the result of removing liquidity.
+ */
+export type RemoveLiquidity = CallResult<{
+    ok: boolean;
+}>;
+
+/**
+ * @description Represents the result of listing liquidity (new).
+ */
+export type ListLiquidity = CallResult<{
+    ok: boolean;
+}>;
+
+/**
+ * @description Represents the result of canceling a listing (new).
+ */
+export type CancelListing = CallResult<{
+    totalTokensReturned: bigint;
+}>;
+
+/**
+ * @description Represents the result of creating a new pool (new).
+ */
+export type CreatePool = CallResult<{
+    ok: boolean;
+}>;
+
+/**
+ * @description Represents the result of setting fees (new).
+ */
+export type SetFees = CallResult<{
+    ok: boolean;
+}>;
+
+/**
+ * @description Represents the result of retrieving the fees (new).
+ */
+export type GetFees = CallResult<{
+    reservationBaseFee: bigint;
+    priorityQueueBaseFee: bigint;
+    pricePerUserInPriorityQueueBTC: bigint;
+}>;
+
+/**
+ * @description Represents the result of a swap operation.
+ */
+export type Swap = CallResult<{
+    ok: boolean;
+}>;
+
+/**
+ * @description Represents the result of the getReserve function call.
+ * Now includes virtualBTCReserve and virtualTokenReserve.
+ */
+export type GetReserve = CallResult<{
+    liquidity: bigint;
+    reservedLiquidity: bigint;
+    virtualBTCReserve: bigint;
+    virtualTokenReserve: bigint;
+}>;
+
+/**
+ * @description Represents the result of the getQuote function call.
+ * Renamed currentPrice -> price.
+ */
+export type GetQuote = CallResult<{
+    tokensOut: bigint;
+    requiredSatoshis: bigint;
+    price: bigint;
+}>;
+
+/**
+ * @description Represents the result of retrieving provider details.
+ */
+export type GetProviderDetails = CallResult<{
+    liquidity: bigint;
+    reserved: bigint;
+    btcReceiver: string;
+}>;
+
+/**
+ * @description Represents the result of retrieving the priority queue cost.
+ */
+export type GetPriorityQueueCost = CallResult<{
+    cost: bigint;
+}>;
+
+/**
+ * @description Represents the result of retrieving the virtual reserves
+ */
+export type VirtualReserves = CallResult<{
+    virtualBTCReserve: bigint;
+    virtualTokenReserve: bigint;
+}>;
+
+/**
+ * @description This interface represents the NativeSwap contract,
+ * including all new/updated methods and type definitions.
+ *
+ * @interface INativeSwapContract
+ * @extends {IOP_NETContract}
+ * @category Contracts
+ */
+export interface INativeSwapContract extends IOP_NETContract {
+    /**
+     * @description Reserves a certain amount of tokens, possibly for LP.
+     * @param token - The address of the token to reserve.
+     * @param maximumAmountIn - The maximum amount of tokens to reserve.
+     * @param minimumAmountOut - The minimum amount of tokens expected out.
+     * @param forLP - Whether this reservation is for LP or not.
+     * @returns {Promise<ReserveEWMA>}
+     */
+    reserve(
+        token: Address,
+        maximumAmountIn: bigint,
+        minimumAmountOut: bigint,
+        forLP: boolean,
+    ): Promise<ReserveEWMA>;
+
+    /**
+     * @description Lists liquidity for sale (new).
+     * @param token - The address of the token to list.
+     * @param receiver - The Bitcoin address for receiving payments.
+     * @param amountIn - The amount of tokens to list for sale.
+     * @param priority - Whether to place this listing in the priority queue.
+     * @returns {Promise<ListLiquidity>}
+     */
+    listLiquidity(
+        token: Address,
+        receiver: string,
+        amountIn: bigint,
+        priority: boolean,
+    ): Promise<ListLiquidity>;
+
+    /**
+     * @description Cancels a previously listed liquidity position (new).
+     * @param token - The address of the token to remove from the listing.
+     * @returns {Promise<CancelListing>}
+     */
+    cancelListing(token: Address): Promise<CancelListing>;
+
+    /**
+     * @description Creates a new liquidity pool (new).
+     * @param token - The token address.
+     * @param floorPrice - The floor price to set.
+     * @param initialLiquidity - The amount of liquidity to seed.
+     * @param receiver - The Bitcoin address for receiving payments.
+     * @param antiBotEnabledFor - Number of blocks for anti-bot protection.
+     * @param antiBotMaximumTokensPerReservation - Anti-bot max tokens per user.
+     * @param maxReservesIn5BlocksPercent - Cap on reserves in a short window.
+     * @returns {Promise<CreatePool>}
+     */
+    createPool(
+        token: Address,
+        floorPrice: bigint,
+        initialLiquidity: bigint,
+        receiver: string,
+        antiBotEnabledFor: number,
+        antiBotMaximumTokensPerReservation: bigint,
+        maxReservesIn5BlocksPercent: number,
+    ): Promise<CreatePool>;
+
+    /**
+     * @description Sets the global fee parameters (new).
+     * @param reservationBaseFee - Base fee for a reservation.
+     * @param priorityQueueBaseFee - Base fee for priority queue usage.
+     * @param pricePerUserInPriorityQueueBTC - Additional cost per user in queue.
+     * @returns {Promise<SetFees>}
+     */
+    setFees(
+        reservationBaseFee: bigint,
+        priorityQueueBaseFee: bigint,
+        pricePerUserInPriorityQueueBTC: bigint,
+    ): Promise<SetFees>;
+
+    /**
+     * @description Retrieves the current fee parameters (new).
+     * @returns {Promise<GetFees>}
+     */
+    getFees(): Promise<GetFees>;
+
+    /**
+     * @description Adds liquidity to the contract.
+     * @param token - The address of the token to add liquidity for.
+     * @param receiver - The receiver of the liquidity (Bitcoin address).
+     * @param amountIn - The amount of tokens to add.
+     * @param priority - Whether to prioritize the liquidity addition.
+     * @returns {Promise<AddLiquidity>}
+     */
+    addLiquidity(
+        token: Address,
+        receiver: string,
+        amountIn: bigint,
+        priority: boolean,
+    ): Promise<AddLiquidity>;
+
+    /**
+     * @description Removes liquidity from the contract.
+     * @param token - The address of the token to remove liquidity for.
+     * @returns {Promise<RemoveLiquidity>}
+     */
+    removeLiquidity(token: Address): Promise<RemoveLiquidity>;
+
+    /**
+     * @description Executes a swap operation.
+     * @param token - The address of the token to swap.
+     * @param isSimulation - Whether this is just a simulation.
+     * @returns {Promise<Swap>}
+     */
+    swap(token: Address, isSimulation: boolean): Promise<Swap>;
+
+    /**
+     * @description Retrieves the reserve information for a token.
+     * Now includes virtual pool reserves.
+     * @param token - The address of the token.
+     * @returns {Promise<GetReserve>}
+     */
+    getReserve(token: Address): Promise<GetReserve>;
+
+    /**
+     * @description Retrieves a quote for swapping tokens.
+     * @param token - The address of the token.
+     * @param satoshisIn - The amount of satoshis being sent.
+     * @returns {Promise<GetQuote>}
+     */
+    getQuote(token: Address, satoshisIn: bigint): Promise<GetQuote>;
+
+    /**
+     * @description Retrieves the provider details for a token.
+     * @param token - The address of the token.
+     * @returns {Promise<GetProviderDetails>}
+     */
+    getProviderDetails(token: Address): Promise<GetProviderDetails>;
+
+    /**
+     * @description Retrieves the virtual reserves (akin to EWMA).
+     * @param token - The address of the token.
+     * @returns {Promise<VirtualReserves>}
+     */
+    getVirtualReserves(token: Address): Promise<VirtualReserves>;
+
+    /**
+     * @description Retrieves the cost for using the priority queue (new).
+     * @param token - The address of the token.
+     * @returns {Promise<GetPriorityQueueCost>}
+     */
+    getPriorityQueueCost(token: Address): Promise<GetPriorityQueueCost>;
+}

package/src/abi/shared/json/motoswap/{EWMA_ABI.ts → NATIVE_SWAP_ABI.ts}

@@ -6,9 +6,27 @@ import { OP_NET_ABI } from '../opnet/OP_NET_ABI.js';
 /**
  * @category Events
  */
-export const EwmaEvents: BitcoinInterfaceAbi = [
+export const NativeSwapEvents: BitcoinInterfaceAbi = [
     {
         name: 'LiquidityAdded',
+        values: [
+            {
+                name: 'totalTokensContributed',
+                type: ABIDataTypes.UINT256,
+            },
+            {
+                name: 'virtualTokenExchanged',
+                type: ABIDataTypes.UINT256,
+            },
+            {
+                name: 'totalSatoshisSpent',
+                type: ABIDataTypes.UINT256,
+            },
+        ],
+        type: BitcoinAbiTypes.Event,
+    },
+    {
+        name: 'LiquidityListed',
         values: [
             {
                 name: 'totalLiquidity',
@@ -21,6 +39,24 @@ export const EwmaEvents: BitcoinInterfaceAbi = [
         ],
         type: BitcoinAbiTypes.Event,
     },
+    {
+        name: 'LiquidityRemoved',
+        values: [
+            {
+                name: 'providerId',
+                type: ABIDataTypes.UINT256,
+            },
+            {
+                name: 'btcOwed',
+                type: ABIDataTypes.UINT256,
+            },
+            {
+                name: 'tokenAmount',
+                type: ABIDataTypes.UINT256,
+            },
+        ],
+        type: BitcoinAbiTypes.Event,
+    },
     {
         name: 'ReservationCreated',
         values: [
@@ -36,36 +72,36 @@ export const EwmaEvents: BitcoinInterfaceAbi = [
         type: BitcoinAbiTypes.Event,
     },
     {
-        name: 'LiquidityRemoved',
+        name: 'SwapExecuted',
         values: [
             {
-                name: 'token',
+                name: 'buyer',
                 type: ABIDataTypes.ADDRESS,
             },
             {
-                name: 'amount',
+                name: 'amountIn',
                 type: ABIDataTypes.UINT256,
             },
             {
-                name: 'remainingLiquidity',
+                name: 'amountOut',
                 type: ABIDataTypes.UINT256,
             },
         ],
         type: BitcoinAbiTypes.Event,
     },
     {
-        name: 'SwapExecuted',
+        name: 'Unlist',
         values: [
             {
-                name: 'buyer',
+                name: 'token',
                 type: ABIDataTypes.ADDRESS,
             },
             {
-                name: 'amountIn',
+                name: 'amount',
                 type: ABIDataTypes.UINT256,
             },
             {
-                name: 'amountOut',
+                name: 'remainingLiquidity',
                 type: ABIDataTypes.UINT256,
             },
         ],
@@ -90,7 +126,10 @@ export const EwmaEvents: BitcoinInterfaceAbi = [
 /**
  * @category ABI
  */
-export const EwmaAbi: BitcoinInterfaceAbi = [
+export const NativeSwapAbi: BitcoinInterfaceAbi = [
+    //=================================================
+    // RESERVE
+    //=================================================
     {
         name: 'reserve',
         inputs: [
@@ -106,6 +145,10 @@ export const EwmaAbi: BitcoinInterfaceAbi = [
                 name: 'minimumAmountOut',
                 type: ABIDataTypes.UINT256,
             },
+            {
+                name: 'forLP',
+                type: ABIDataTypes.BOOL,
+            },
         ],
         outputs: [
             {
@@ -116,8 +159,11 @@ export const EwmaAbi: BitcoinInterfaceAbi = [
         type: BitcoinAbiTypes.Function,
     },
 
+    //=================================================
+    // LIST LIQUIDITY
+    //=================================================
     {
-        name: 'addLiquidity',
+        name: 'listLiquidity',
         inputs: [
             {
                 name: 'token',
@@ -145,8 +191,11 @@ export const EwmaAbi: BitcoinInterfaceAbi = [
         type: BitcoinAbiTypes.Function,
     },
 
+    //=================================================
+    // CANCEL LISTING
+    //=================================================
     {
-        name: 'removeLiquidity',
+        name: 'cancelListing',
         inputs: [
             {
                 name: 'token',
@@ -162,18 +211,69 @@ export const EwmaAbi: BitcoinInterfaceAbi = [
         type: BitcoinAbiTypes.Function,
     },
 
+    //=================================================
+    // CREATE POOL
+    //=================================================
     {
-        name: 'swap',
+        name: 'createPool',
         inputs: [
             {
                 name: 'token',
                 type: ABIDataTypes.ADDRESS,
             },
             {
-                name: 'isSimulation',
+                name: 'floorPrice',
+                type: ABIDataTypes.UINT256,
+            },
+            {
+                name: 'initialLiquidity',
+                type: ABIDataTypes.UINT128,
+            },
+            {
+                name: 'receiver',
+                type: ABIDataTypes.STRING,
+            },
+            {
+                name: 'antiBotEnabledFor',
+                type: ABIDataTypes.UINT16,
+            },
+            {
+                name: 'antiBotMaximumTokensPerReservation',
+                type: ABIDataTypes.UINT256,
+            },
+            {
+                name: 'maxReservesIn5BlocksPercent',
+                type: ABIDataTypes.UINT16,
+            },
+        ],
+        outputs: [
+            {
+                name: 'ok',
                 type: ABIDataTypes.BOOL,
             },
         ],
+        type: BitcoinAbiTypes.Function,
+    },
+
+    //=================================================
+    // SET FEES
+    //=================================================
+    {
+        name: 'setFees',
+        inputs: [
+            {
+                name: 'reservationBaseFee',
+                type: ABIDataTypes.UINT64,
+            },
+            {
+                name: 'priorityQueueBaseFee',
+                type: ABIDataTypes.UINT64,
+            },
+            {
+                name: 'pricePerUserInPriorityQueueBTC',
+                type: ABIDataTypes.UINT64,
+            },
+        ],
         outputs: [
             {
                 name: 'ok',
@@ -183,6 +283,104 @@ export const EwmaAbi: BitcoinInterfaceAbi = [
         type: BitcoinAbiTypes.Function,
     },
 
+    //=================================================
+    // GET FEES
+    //=================================================
+    {
+        name: 'getFees',
+        inputs: [],
+        outputs: [
+            {
+                name: 'reservationBaseFee',
+                type: ABIDataTypes.UINT64,
+            },
+            {
+                name: 'priorityQueueBaseFee',
+                type: ABIDataTypes.UINT64,
+            },
+            {
+                name: 'pricePerUserInPriorityQueueBTC',
+                type: ABIDataTypes.UINT64,
+            },
+        ],
+        type: BitcoinAbiTypes.Function,
+    },
+
+    //=================================================
+    // ADD LIQUIDITY
+    //=================================================
+    {
+        name: 'addLiquidity',
+        inputs: [
+            {
+                name: 'token',
+                type: ABIDataTypes.ADDRESS,
+            },
+            {
+                name: 'receiver',
+                type: ABIDataTypes.STRING,
+            },
+            {
+                name: 'amountIn',
+                type: ABIDataTypes.UINT128,
+            },
+            {
+                name: 'priority',
+                type: ABIDataTypes.BOOL,
+            },
+        ],
+        outputs: [
+            {
+                name: 'ok',
+                type: ABIDataTypes.BOOL,
+            },
+        ],
+        type: BitcoinAbiTypes.Function,
+    },
+
+    //=================================================
+    // REMOVE LIQUIDITY (changed return type)
+    //=================================================
+    {
+        name: 'removeLiquidity',
+        inputs: [
+            {
+                name: 'token',
+                type: ABIDataTypes.ADDRESS,
+            },
+        ],
+        outputs: [
+            {
+                name: 'ok',
+                type: ABIDataTypes.BOOL,
+            },
+        ],
+        type: BitcoinAbiTypes.Function,
+    },
+
+    //=================================================
+    // SWAP
+    //=================================================
+    {
+        name: 'swap',
+        inputs: [
+            {
+                name: 'token',
+                type: ABIDataTypes.ADDRESS,
+            },
+        ],
+        outputs: [
+            {
+                name: 'ok',
+                type: ABIDataTypes.BOOL,
+            },
+        ],
+        type: BitcoinAbiTypes.Function,
+    },
+
+    //=================================================
+    // GET RESERVE
+    //=================================================
     {
         name: 'getReserve',
         inputs: [
@@ -200,10 +398,21 @@ export const EwmaAbi: BitcoinInterfaceAbi = [
                 name: 'reservedLiquidity',
                 type: ABIDataTypes.UINT256,
             },
+            {
+                name: 'virtualBTCReserve',
+                type: ABIDataTypes.UINT256,
+            },
+            {
+                name: 'virtualTokenReserve',
+                type: ABIDataTypes.UINT256,
+            },
         ],
         type: BitcoinAbiTypes.Function,
     },
 
+    //=================================================
+    // GET QUOTE
+    //=================================================
     {
         name: 'getQuote',
         inputs: [
@@ -226,36 +435,43 @@ export const EwmaAbi: BitcoinInterfaceAbi = [
                 type: ABIDataTypes.UINT256,
             },
             {
-                name: 'currentPrice',
+                name: 'price',
                 type: ABIDataTypes.UINT256,
             },
         ],
         type: BitcoinAbiTypes.Function,
     },
 
+    //=================================================
+    // GET PROVIDER DETAILS
+    //=================================================
     {
-        name: 'setQuote',
+        name: 'getProviderDetails',
         inputs: [
             {
                 name: 'token',
                 type: ABIDataTypes.ADDRESS,
             },
-            {
-                name: 'p0',
-                type: ABIDataTypes.UINT256,
-            },
         ],
         outputs: [
             {
-                name: 'ok',
-                type: ABIDataTypes.BOOL,
+                name: 'liquidity',
+                type: ABIDataTypes.UINT128,
+            },
+            {
+                name: 'reserved',
+                type: ABIDataTypes.UINT128,
+            },
+            {
+                name: 'btcReceiver',
+                type: ABIDataTypes.STRING,
             },
         ],
         type: BitcoinAbiTypes.Function,
     },
 
     {
-        name: 'priorityQueueCost',
+        name: 'getVirtualReserves',
         inputs: [
             {
                 name: 'token',
@@ -264,15 +480,22 @@ export const EwmaAbi: BitcoinInterfaceAbi = [
         ],
         outputs: [
             {
-                name: 'cost',
-                type: ABIDataTypes.UINT128,
+                name: 'virtualBTCReserve',
+                type: ABIDataTypes.UINT256,
+            },
+            {
+                name: 'virtualTokenReserve',
+                type: ABIDataTypes.UINT256,
             },
         ],
         type: BitcoinAbiTypes.Function,
     },
 
+    //=================================================
+    // GET PRIORITY QUEUE COST
+    //=================================================
     {
-        name: 'getProviderDetails',
+        name: 'getPriorityQueueCost',
         inputs: [
             {
                 name: 'token',
@@ -281,22 +504,14 @@ export const EwmaAbi: BitcoinInterfaceAbi = [
         ],
         outputs: [
             {
-                name: 'liquidity',
-                type: ABIDataTypes.UINT128,
-            },
-            {
-                name: 'reserved',
-                type: ABIDataTypes.UINT128,
-            },
-            {
-                name: 'btcReceiver',
-                type: ABIDataTypes.STRING,
+                name: 'cost',
+                type: ABIDataTypes.UINT64,
             },
         ],
         type: BitcoinAbiTypes.Function,
     },
 
-    ...EwmaEvents,
+    ...NativeSwapEvents,
 
     // OP_NET
     ...OP_NET_ABI,