Class SwapAggregator

Hierarchy

SwapAggregator

Constructors

constructor

new SwapAggregator(environment, options?): SwapAggregator
Parameters
- environment: Environment
  
  API endpoint environment
- Optional options: {
  providers?: ConnectionProviders;
  signers?: TransactionSigners;
  }
  
  swap options
  - Optional providers?: ConnectionProviders
  - Optional signers?: TransactionSigners
Returns SwapAggregator
- Defined in swap/initialize.ts:76

Properties

environment

environment: Environment

`Optional` providers

providers?: ConnectionProviders

`Optional` signer

signer?: TransactionSigners

Methods

checkIsSwappableSWFT

checkIsSwappableSWFT(quote): Promise<{
error: boolean;
message: string;
}>
Parameters
- quote: CrossChainQuote
Returns Promise<{
error: boolean;
message: string;
}>
- Defined in swap/initialize.ts:647

crossChainQuote

crossChainQuote(params): Promise<{
data: CrossChainQuote[];
message: string;
}>
Retrieves a cross-chain quote for a given set of parameters.
Parameters
- params: CrossChainSwapParams
  
  The parameters for the cross-chain swap.
Returns Promise<{
data: CrossChainQuote[];
message: string;
}>
A promise that resolves to the cross-chain quote.
- Defined in swap/initialize.ts:257

executeClaim

executeClaim(params): Promise<any>
Executes a cross-chain claim based on the provided parameters.
Parameters
- params: ExecuteCrossChainClaimParams
  
  The parameters for executing the cross-chain claim.
Returns Promise<any>
A promise that resolves to the result of the cross-chain claim execution.
- Defined in swap/initialize.ts:497

`Private` executeCrossChainEVM

executeCrossChainEVM(params): Promise<undefined | string>
Parameters
- params: ExecuteCrossChainSwapParams
Returns Promise<undefined | string>
- Defined in swap/initialize.ts:330

`Private` executeCrossChainSwap

executeCrossChainSwap(params): Promise<undefined | string>
Parameters
- params: ExecuteCrossChainSwapParams
Returns Promise<undefined | string>
- Defined in swap/initialize.ts:269

executeSwapInstruction

executeSwapInstruction(params): Promise<undefined | string>
Executes a swap instruction based on the provided parameters.

Throws
An error if the network ID is invalid or if the required connection provider or signer is not provided.
Parameters
- params: ExecuteSameChainInstructionParams
  
  The parameters for executing the swap instruction.
Returns Promise<undefined | string>
A promise that resolves to the result of executing the swap instruction.
- Defined in swap/initialize.ts:116

executeTransfer

executeTransfer(params): Promise<{
success: boolean;
txHash: string;
}>
Executes a cross-chain transfer based on the provided parameters.

Throws
An error if the transfer hash is not found or if an invalid bridge is specified.
Parameters
- params: ExecuteCrossChainTransferParams
  
  The parameters for the cross-chain transfer.
Returns Promise<{
success: boolean;
txHash: string;
}>
A promise that resolves to the result of the cross-chain transfer.
- Defined in swap/initialize.ts:445

`Private` getAttestation

getAttestation(params): Promise<{
    attestationSignature: undefined;
    destHash: any;
    messageBytes: undefined;
    vaa: undefined;
} | {
    attestationSignature: undefined;
    destHash: undefined;
    messageBytes: undefined;
    vaa: Buffer;
} | {
    attestationSignature: any;
    destHash: undefined;
    messageBytes: any;
    vaa: undefined;
}>
Parameters
- params: getAttesationParams
Returns Promise<{
    attestationSignature: undefined;
    destHash: any;
    messageBytes: undefined;
    vaa: undefined;
} | {
    attestationSignature: undefined;
    destHash: undefined;
    messageBytes: undefined;
    vaa: Buffer;
} | {
    attestationSignature: any;
    destHash: undefined;
    messageBytes: any;
    vaa: undefined;
}>
- Defined in swap/initialize.ts:526

getClaimIx

getClaimIx(params): Promise<{
data: any;
message: string;
}>
Retrieves the claim instruction for a cross-chain claim .
Parameters
- params: GetCrossChainClaimParams
  
  The parameters for the claim instruction.
Returns Promise<{
data: any;
message: string;
}>
serialised instruction to claim
- Defined in swap/initialize.ts:536

getCrossChainGasUsedData

getCrossChainGasUsedData(quote, txHash): Promise<undefined | string>
Parameters
- quote: CrossChainQuote
- txHash: string
Returns Promise<undefined | string>
- Defined in swap/initialize.ts:620

getCrossChainSwapInstruction

getCrossChainSwapInstruction(params): Promise<{
data: any;
message: string;
}>
Retrieves the cross-chain swap instruction for executing a cross-chain swap.
Parameters
- params: ExecuteCrossChainSwapParams
  
  The parameters for executing the cross-chain swap.
Returns Promise<{
data: any;
message: string;
}>
A promise that resolves to the cross-chain swap instruction.
- Defined in swap/initialize.ts:316

`Private` getProvider

getProvider(chain): Promise<Connection | Aptos | JsonRpcProvider | BaseProvider>
Parameters
- chain: NetworkId
Returns Promise<Connection | Aptos | JsonRpcProvider | BaseProvider>
- Defined in swap/initialize.ts:696

getRedeemFeeEVM

getRedeemFeeEVM(targetChain, targetProvider, bridge): Promise<string>
Parameters
- targetChain: NetworkId
- targetProvider: Aptos | JsonRpcProvider | BaseProvider
- bridge: BridgeId
Returns Promise<string>
- Defined in swap/initialize.ts:551

getSameChainGasUsedData

getSameChainGasUsedData(quote, txHash): Promise<undefined | string>
Parameters
- quote: CommonRouteInterface
- txHash: string
Returns Promise<undefined | string>
- Defined in swap/initialize.ts:592

redeem

redeem(params): Promise<any>
Redeems a failed cross-chain transfer

Throws
Error if the redemption fails or if the bridge is unsupported.
Parameters
- params: RedeemParams
  
  The parameters for the redemption.
Returns Promise<any>
The hash of the redemption transaction.
- Defined in swap/initialize.ts:675

swapInstruction

swapInstruction(params): Promise<{
data: any;
message: string;
}>
Get swap instructions to execute same chain swap
Parameters
- params: SameChainInstructionParams
  
  The parameters for the same chain swap instruction
Returns Promise<{
data: any;
message: string;
}>
The swap instructions for executing the same chain swap
- Defined in swap/initialize.ts:105

swapQuotes

swapQuotes(params): Promise<{
data: CommonRouteInterface[];
message: string;
}>
Get swap quote for same chain swaps
Parameters
- params: SameChainSwapParams
Returns Promise<{
data: CommonRouteInterface[];
message: string;
}>
- Defined in swap/initialize.ts:87

Class SwapAggregator

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

environment: Environment

Optional options: { providers?: ConnectionProviders; signers?: TransactionSigners; }

Optional providers?: ConnectionProviders

Optional signers?: TransactionSigners

Returns SwapAggregator

Properties

environment

Optional providers

Optional signer

Methods

checkIsSwappableSWFT

Parameters

quote: CrossChainQuote

Returns Promise<{ error: boolean; message: string; }>

crossChainQuote

Parameters

params: CrossChainSwapParams

Returns Promise<{ data: CrossChainQuote[]; message: string; }>

executeClaim

Parameters

params: ExecuteCrossChainClaimParams

Returns Promise<any>

Private executeCrossChainEVM

Parameters

params: ExecuteCrossChainSwapParams

Returns Promise<undefined | string>

Private executeCrossChainSwap

Parameters

params: ExecuteCrossChainSwapParams

Returns Promise<undefined | string>

executeSwapInstruction

Throws

Parameters

params: ExecuteSameChainInstructionParams

Returns Promise<undefined | string>

executeTransfer

Throws

Parameters

params: ExecuteCrossChainTransferParams

Returns Promise<{ success: boolean; txHash: string; }>

Private getAttestation

Parameters

params: getAttesationParams

Returns Promise<{ attestationSignature: undefined; destHash: any; messageBytes: undefined; vaa: undefined; } | { attestationSignature: undefined; destHash: undefined; messageBytes: undefined; vaa: Buffer; } | { attestationSignature: any; destHash: undefined; messageBytes: any; vaa: undefined; }>

getClaimIx

Parameters

params: GetCrossChainClaimParams

Returns Promise<{ data: any; message: string; }>

getCrossChainGasUsedData

Parameters

quote: CrossChainQuote

txHash: string

Returns Promise<undefined | string>

getCrossChainSwapInstruction

Parameters

params: ExecuteCrossChainSwapParams

Returns Promise<{ data: any; message: string; }>

Private getProvider

Parameters

chain: NetworkId

Returns Promise<Connection | Aptos | JsonRpcProvider | BaseProvider>

getRedeemFeeEVM

Parameters

targetChain: NetworkId

targetProvider: Aptos | JsonRpcProvider | BaseProvider

bridge: BridgeId

Returns Promise<string>

getSameChainGasUsedData

Parameters

quote: CommonRouteInterface

txHash: string

`Optional` options: {
providers?: ConnectionProviders;
signers?: TransactionSigners;
}

`Optional` providers?: ConnectionProviders

`Optional` signers?: TransactionSigners

`Optional` providers

`Optional` signer

Returns Promise<{
error: boolean;
message: string;
}>

Returns Promise<{
data: CrossChainQuote[];
message: string;
}>

`Private` executeCrossChainEVM

`Private` executeCrossChainSwap

Returns Promise<{
success: boolean;
txHash: string;
}>

`Private` getAttestation

Returns Promise<{
attestationSignature: undefined;
destHash: any;
messageBytes: undefined;
vaa: undefined;
} | {
attestationSignature: undefined;
destHash: undefined;
messageBytes: undefined;
vaa: Buffer;
} | {
attestationSignature: any;
destHash: undefined;
messageBytes: any;
vaa: undefined;
}>

Returns Promise<{
data: any;
message: string;
}>

Returns Promise<{
data: any;
message: string;
}>

`Private` getProvider

Returns Promise<{
data: any;
message: string;
}>

Returns Promise<{
data: CommonRouteInterface[];
message: string;
}>