opnet 1.2.1 → 1.2.3

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

@@ -0,0 +1,348 @@
+import { Address } from '@btc-vision/transaction';
+import { IOwnableReentrancyGuardContract } from './IOwnableReentrancyGuardContract';
+import { CallResult } from '../../../../opnet';
+
+export type PoolInfo = {
+    allocPoint: number;
+    lastRewardBlock: number;
+    accMotoPerShare: bigint;
+};
+
+export type UserInfo = {
+    amount: bigint;
+    rewardDebt: bigint;
+};
+
+export type Initialize = CallResult<{
+    success: boolean;
+}>;
+
+export type GetLpToken = CallResult<{
+    lpTokenAddress: Address;
+}>;
+
+export type GetRewarder = CallResult<{
+    rewarderAddress: Address;
+}>;
+
+export type GetPoolInfo = CallResult<PoolInfo>;
+
+export type GetUserInfo = CallResult<UserInfo>;
+
+export type Pools = CallResult<{
+    poolLength: number;
+    poolsData: Uint8Array;
+}>;
+
+export type TotalAllocPoint = CallResult<{
+    totalAllocPoint: bigint;
+}>;
+
+export type Devaddr = CallResult<{
+    devaddr: Address;
+}>;
+
+export type MotoPerBlock = CallResult<{
+    motoPerBlock: bigint;
+}>;
+
+export type BonusEndBlock = CallResult<{
+    bonusEndBlock: bigint;
+}>;
+
+export type BonusMultiplier = CallResult<{
+    bonusMultiplier: bigint;
+}>;
+
+export type Add = CallResult<{
+    success: boolean;
+}>;
+
+export type Set = CallResult<{
+    success: boolean;
+}>;
+
+export type SetMigrator = CallResult<{
+    success: boolean;
+}>;
+
+export type Migrate = CallResult<{
+    success: boolean;
+}>;
+
+export type GetMultiplier = CallResult<{
+    multiplier: bigint;
+}>;
+
+export type PendingMoto = CallResult<{
+    pendingMoto: number;
+}>;
+
+export type MassUpdatePools = CallResult<{
+    success: boolean;
+}>;
+
+export type UpdatePool = CallResult<PoolInfo>;
+
+export type Deposit = CallResult<{
+    success: boolean;
+}>;
+
+export type Withdraw = CallResult<{
+    success: boolean;
+}>;
+
+export type Harvest = CallResult<{
+    success: boolean;
+}>;
+
+export type WithdrawAndHarvest = CallResult<{
+    success: boolean;
+}>;
+
+export type SetDev = CallResult<{
+    success: boolean;
+}>;
+
+export type SetMotoPerBlock = CallResult<{
+    success: boolean;
+}>;
+
+export type SetBonusEndBlock = CallResult<{
+    success: boolean;
+}>;
+
+export type SetBonusMultiplier = CallResult<{
+    success: boolean;
+}>;
+
+export type EmergencyWithdraw = CallResult<{
+    success: boolean;
+}>;
+
+/**
+ * @description This interface represents the MotoChef contract.
+ * @interface IMotoChefContract
+ * @extends {IOwnableReentrancyGuardContract}
+ * @cathegory Contracts
+ */
+export interface IMotoChefContract extends IOwnableReentrancyGuardContract {
+    /**
+     * @description Initialize the MotoChef contract. Can only be called by an admin.
+     * @param {Address} MOTO The address of the MOTO token. MotoChef needs to be the owner/admin of the MOTO token.
+     * @param {bigint} premineAmount The amount of MOTO to mint on deploy.
+     * @param {Address} devaddr The address of the dev.
+     * @param {bigint} motoPerBlock The amount of MOTOs created per block.
+     * @param {bigint} bonusEndBlock The block number when the bonus MOTO period ends.
+     * @param {bigint} bonusMultiplier The bonus muliplier for early moto makers.
+     * @returns {Initialize}
+     */
+    initialize(
+        MOTO: Address,
+        premineAmount: bigint,
+        devaddr: Address,
+        motoPerBlock: bigint,
+        bonusEndBlock: bigint,
+        bonusMultiplier: bigint,
+    ): Promise<Initialize>;
+
+    /**
+     * @description Gets the LP token address of a pool
+     * @param {number} pid The index of the pool
+     * @returns {GetLpToken}
+     */
+    getLpToken(pid: number): Promise<GetLpToken>;
+
+    /**
+     * @description Gets the rewarder address of a pool
+     * @param {number} pid The index of the pool
+     * @returns {GetRewarder}
+     */
+    getRewarder(pid: number): Promise<GetRewarder>;
+
+    /**
+     * @description Gets the pool info of a pool
+     * @param {number} pid The index of the pool
+     * @returns {GetPoolInfo}
+     */
+    getPoolInfo(pid: number): Promise<GetPoolInfo>;
+
+    /**
+     * @description Gets the user info of a pool
+     * @param {number} pid The index of the pool
+     * @param {Address} user The address of the user
+     * @returns {GetUserInfo}
+     */
+    getUserInfo(pid: number, user: Address): Promise<GetUserInfo>;
+
+    /**
+     * @description Gets all the available pools
+     * @returns {Pools}
+     */
+    pools(): Promise<Pools>;
+
+    /**
+     * @description Gets the total alloc point
+     * @returns {TotalAllocPoint}
+     */
+    totalAllocPoint(): Promise<TotalAllocPoint>;
+
+    /**
+     * @description Gets the dev address
+     * @returns {Devaddr}
+     */
+    devaddr(): Promise<Devaddr>;
+
+    /**
+     * @description Gets the moto per block
+     * @returns {MotoPerBlock}
+     */
+    getMotoPerBlock(): Promise<MotoPerBlock>;
+
+    /**
+     * @description Gets the bonus end block
+     * @returns {BonusEndBlock}
+     */
+    getBonusEndBlock(): Promise<BonusEndBlock>;
+
+    /**
+     * @description Gets the bonus multiplier
+     * @returns {BonusMultiplier}
+     */
+    getBonusMultiplier(): Promise<BonusMultiplier>;
+
+    /**
+     * @description Set the moto per block. Can only be called by an admin.
+     * @param {bigint} motoPerBlock The amount of MOTO per block.
+     * @returns {SetMotoPerBlock}
+     */
+    setMotoPerBlock(motoPerBlock: bigint): Promise<SetMotoPerBlock>;
+
+    /**
+     * @description Set the bonus end block. Can only be called by an admin.
+     * @param {bigint} bonusEndBlock The block number when the bonus period ends.
+     * @returns {SetBonusEndBlock}
+     */
+    setBonusEndBlock(bonusEndBlock: bigint): Promise<SetBonusEndBlock>;
+
+    /**
+     * @description Set the bonus multiplier. Can only be called by an admin.
+     * @param {bigint} bonusMultiplier The bonus multiplier.
+     * @returns {SetBonusMultiplier}
+     */
+    setBonusMultiplier(bonusMultiplier: bigint): Promise<SetBonusMultiplier>;
+
+    /**
+     * @description Add a new lp to the pool. Can only be called by an admin.
+     * @param {bigint} allocPoint allocPoint AP of the new pool.
+     * @param {Address} lpToken Address of the LP OP-20 token.
+     * @param {Address} rewarder Address of the rewarder delegate.
+     * @returns {Add}
+     */
+    add(allocPoint: bigint, lpToken: Address, rewarder: Address): Promise<Add>;
+
+    /**
+     * @description Update the given pool's MOTO allocation point and `IRewarder` contract. Can only be called by an admin.
+     * @param {number} pid the index of the pool
+     * @param {bigint} allocPoint New AP of the pool.
+     * @param {Address} rewarder Address of the rewarder delegate.
+     * @param {boolean} overwrite True if _rewarder should be `set`. Otherwise `_rewarder` is ignored.
+     * @returns {Set}
+     */
+    set(pid: number, allocPoint: bigint, rewarder: Address, overwrite: boolean): Promise<Set>;
+
+    /**
+     * @description Set the `migrator` contract. Can only be called by an admin.
+     * @param {Address} migrator The contract address to set.
+     * @returns {SetMigrator}
+     */
+    setMigrator(migrator: Address): Promise<SetMigrator>;
+
+    /**
+     * @description Migrate LP token to another LP contract through the `migrator` contract.
+     * @param {number} pid The index of the pool.
+     * @returns {Migrate}
+     */
+    migrate(pid: number): Promise<Migrate>;
+
+    /**
+     * @description Get the multiplier over the given _from to _to block.
+     * @param {bigint} from the from block
+     * @param {bigint} to the to block
+     * @returns {GetMultiplier}
+     */
+    getMultiplier(from: bigint, to: bigint): Promise<GetMultiplier>;
+
+    /**
+     * @description View function to see pending MOTO on frontend.
+     * @param {number} pid The index of the pool
+     * @param {Address} user Address of user.
+     * @returns {PendingMoto}
+     */
+    pendingMoto(pid: number, user: Address): Promise<PendingMoto>;
+
+    /**
+     * @description Update reward variables for all pools. Be careful of gas spending!
+     * @param {number} length The length of the pids array.
+     * @param {number[]} pids Pool IDs of all to be updated. Make sure to update all active pools.
+     * @returns {MassUpdatePools}
+     */
+    massUpdatePools(length: number, pids: number[]): Promise<MassUpdatePools>;
+
+    /**
+     * @description Update reward variables of the given pool.
+     * @param {number} pid The index of the pool
+     * @returns {UpdatePool}
+     */
+    updatePool(pid: number): Promise<UpdatePool>;
+
+    /**
+     * @description Deposit LP tokens to MotoChef for MOTO allocation.
+     * @param {number} pid The index of the pool.
+     * @param {bigint} amount LP token amount to deposit.
+     * @param {Address} to The receiver of `amount` deposit benefit.
+     * @returns {Deposit}
+     */
+    deposit(pid: number, amount: bigint, to: Address): Promise<Deposit>;
+
+    /**
+     * @description Withdraw LP tokens from MotoChef.
+     * @param {number} pid The index of the pool.
+     * @param {bigint} amount LP token amount to deposit.
+     * @param {Address} to The receiver of `amount` deposit benefit.
+     * @returns {Withdraw}
+     */
+    withdraw(pid: number, amount: bigint, to: Address): Promise<Withdraw>;
+
+    /**
+     * @description Harvest proceeds for transaction sender to `to`.
+     * @param {number} pid The index of the pool.
+     * @param {Address} to Receiver of MOTO rewards.
+     * @returns {Harvest}
+     */
+    harvest(pid: number, to: Address): Promise<Harvest>;
+
+    /**
+     * @description Withdraw LP tokens from MotoChef and harvest proceeds for transaction sender to `to`.
+     * @param {number} pid The index of the pool.
+     * @param {bigint} amount LP token amount to withdraw.
+     * @param {Address} to Receiver of the LP tokens and MOTO rewards.
+     * @returns {WithdrawAndHarvest}
+     */
+    withdrawAndHarvest(pid: number, amount: bigint, to: Address): Promise<WithdrawAndHarvest>;
+
+    /**
+     * @description Withdraw without caring about rewards. EMERGENCY ONLY.
+     * @param {number} pid The index of the pool.
+     * @param {Address} to Receiver of the LP tokens.
+     * @returns {EmergencyWithdraw}
+     */
+    emergencyWithdraw(pid: number, to: Address): Promise<EmergencyWithdraw>;
+
+    /**
+     * @description Update dev address by the previous dev.
+     * @param {Address} devaddr The new dev address.s
+     * @returns {SetDev}
+     */
+    setDev(devaddr: Address): Promise<SetDev>;
+}

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/interfaces/motoswap/IOwnableContract.ts

@@ -0,0 +1,32 @@
+import { Address } from '@btc-vision/transaction';
+import { CallResult, IOP_NETContract } from '../../../../opnet';
+
+export type Admin = CallResult<{
+    adminAddress: Address;
+}>;
+
+export type ChangeAdmin = CallResult<{
+    success: boolean;
+}>;
+
+/**
+ * @description This interface represents the Ownable contract. It adds the ability to have an admin address that can access certain methods.
+ * @interface IOwnableContract
+ * @extends {IOP_NETContract}
+ * @category Contracts
+ *
+ */
+export interface IOwnableContract extends IOP_NETContract {
+    /**
+     * @description Gets the current admin address.
+     * @returns {Admin}
+     */
+    admin(): Promise<Admin>;
+
+    /**
+     * @description Changes the contract admin. Only callable by the current admin.
+     * @param {Address} newAdmin The new admin address.
+     * @returns {ChangeAdmin}
+     */
+    changeAdmin(newAdmin: Address): Promise<ChangeAdmin>;
+}

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

@@ -0,0 +1,33 @@
+import { Address } from '@btc-vision/transaction';
+import { CallResult } from '../../../../opnet';
+import { IReentrancyGuard } from './IReentrancyGuardContract';
+
+export type Admin = CallResult<{
+    adminAddress: Address;
+}>;
+
+export type ChangeAdmin = CallResult<{
+    success: boolean;
+}>;
+
+/**
+ * @description This interface represents the OwnableReentrancyGuard contract.
+ * @interface IOwnableContract
+ * @extends {IOP_NETContract}
+ * @category Contracts
+ *
+ */
+export interface IOwnableReentrancyGuardContract extends IReentrancyGuard {
+    /**
+     * @description Gets the current admin address.
+     * @returns {Admin}
+     */
+    admin(): Promise<Admin>;
+
+    /**
+     * @description Changes the contract admin. Only callable by the current admin.
+     * @param {Address} newAdmin The new admin address.
+     * @returns {ChangeAdmin}
+     */
+    changeAdmin(newAdmin: Address): Promise<ChangeAdmin>;
+}

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

@@ -0,0 +1,18 @@
+import { CallResult, IOP_NETContract } from '../../../../opnet';
+
+export type Status = CallResult<{ status: bigint }>;
+
+/**
+ * @description This interface represents the ReentrancyGuard contract.
+ * @interface IReentrancyGuardContract
+ * @extends {IOP_NETContract}
+ * @category Contracts
+ *
+ */
+export interface IReentrancyGuard extends IOP_NETContract {
+    /**
+     * @description Gets the current admin address.
+     * @returns {Status}
+     */
+    status(): Promise<Status>;
+}