Interface NearIntentsService

NEAR Intents (Messenger.NEAR_INTENTS) quotes and deposits.

Send flow:

getQuote (or getAmountToBeReceived / getAmountToSend with Messenger.NEAR_INTENTS) to show the expected amounts, minAmountOut and the ETA.
buildSendTransaction (or bridge.rawTxBuilder.send with Messenger.NEAR_INTENTS): creates a deposit and builds a plain transfer of the source tokens to its deposit address.
Sign and send the transaction before deposit.deadline.
Optionally submitDeposit with the transaction hash to speed up the processing.

No approval is needed. Source chains: EVM, SOL, TRX, SRB and SUI (ALG and STX are not supported).

interface NearIntentsService {
    buildSendTransaction(
        params: NearIntentsSendParams,
        provider?: Provider,
    ): Promise<NearIntentsSendTransaction>;
    createDeposit(
        params: NearIntentsCreateDepositParams,
    ): Promise<NearIntentsDeposit>;
    getQuote(params: NearIntentsQuoteParams): Promise<NearIntentsQuote>;
    submitDeposit(params: NearIntentsSubmitDepositParams): Promise<void>;
}

Index

Methods

buildSendTransaction createDeposit getQuote submitDeposit

Methods

buildSendTransaction

buildSendTransaction(
params: NearIntentsSendParams,
provider?: Provider,
): Promise<NearIntentsSendTransaction>
Builds the deposit transaction of a NEAR Intents transfer: uses params.nearIntentsDeposit or creates a new deposit (EXACT_INPUT), then a plain transfer of its amountIn to its deposit address (a native currency transfer when the source token isNative).
Parameters
- params: NearIntentsSendParams
  See NearIntentsSendParams
- Optionalprovider: Provider
  will be used to access the network. Optional
Returns Promise<NearIntentsSendTransaction>
NearIntentsSendTransaction
- Defined in src/services/near-intents/index.ts:75

createDeposit

createDeposit(
params: NearIntentsCreateDepositParams,
): Promise<NearIntentsDeposit>
Creates a NEAR Intents deposit: a quote with a one-shot deposit address. The deposit must be funded before its deadline.
Parameters
- params: NearIntentsCreateDepositParams
  See NearIntentsCreateDepositParams
Returns Promise<NearIntentsDeposit>
NearIntentsDeposit with float amounts

Throws
the same errors as getQuote
- Defined in src/services/near-intents/index.ts:57

getQuote

getQuote(params: NearIntentsQuoteParams): Promise<NearIntentsQuote>
Fetches a NEAR Intents quote.
Parameters
- params: NearIntentsQuoteParams
  See NearIntentsQuoteParams
Returns Promise<NearIntentsQuote>
NearIntentsQuote with float amounts

Throws
NearIntentsDoesNotSupportedError if the route is not supported, NearIntentsAmountTooLowError, NearIntentsNoLiquidityError or NearIntentsQuoteError if no quote is available
- Defined in src/services/near-intents/index.ts:48

submitDeposit

submitDeposit(params: NearIntentsSubmitDepositParams): Promise<void>
Notifies NEAR Intents about the deposit transaction to speed up its detection. Optional: errors are logged and never thrown.
Parameters
- params: NearIntentsSubmitDepositParams
  See NearIntentsSubmitDepositParams
Returns Promise<void>
- Defined in src/services/near-intents/index.ts:64