Class SynapseSolanaEngine

Hierarchy

EventEmitter
- SynapseSolanaEngine

Constructors

constructor

new SynapseSolanaEngine(config): SynapseSolanaEngine
Parameters
- config: DeFiConfig
Returns SynapseSolanaEngine
Overrides EventEmitter.constructor
- Defined in packages/synapse-client-sdk/src/defi/utils.ts:239

Properties

`Static`prefixed

prefixed: string | boolean

Methods

addListener

addListener<T>(event, fn, context?): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.addListener
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:45

decodeBase64Tx

decodeBase64Tx(txBase64): Promise<Transaction | VersionedTransaction>
Decode a base64 transaction into a Transaction or VersionedTransaction. Supports both Node.js (Buffer) and browser (atob) environments.
Parameters
- txBase64: string
Returns Promise<Transaction | VersionedTransaction>
- Defined in packages/synapse-client-sdk/src/defi/utils.ts:625

emit

emit<T>(event, ...args): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Rest...args: any[]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (string | symbol)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (string | symbol)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:15

executeSwap

executeSwap(params): Promise<{
signature?: string;
tx?: Transaction | VersionedTransaction;
}>
Sign and (optionally) send a prepared base64 transaction.
Parameters
- params: ExecuteSwapParams
Returns Promise<{
signature?: string;
tx?: Transaction | VersionedTransaction;
}>
Requires
SynapseClient to implement signAndSend(tx, opts) or sendRawTransaction(raw, opts)
- Defined in packages/synapse-client-sdk/src/defi/utils.ts:664

getTokenInfo

getTokenInfo(mint): Promise<TokenInfo>
Get token info from registry or well-known tokens
Parameters
- mint: string
  Token mint address (base58)
Returns Promise<TokenInfo>
TokenInfo object with symbol, decimals, etc.

Note
Override via config.tokenRegistry for custom token data sources
- Defined in packages/synapse-client-sdk/src/defi/utils.ts:307

healthCheck

healthCheck(): Promise<{
    details: {
        hasCustomBuilder: boolean;
        hasTokenRegistry: boolean;
        jupiterBase: string;
        jupiterPaths: {
            quote: string;
            swap: string;
        };
        logLevel:
            | "none"
            | "error"
            | "info"
            | "debug";
        raydiumBase: string;
        raydiumPaths: {
            quote: string;
            swap: string;
        };
    };
    ok: boolean;
}>
Returns Promise<{
    details: {
        hasCustomBuilder: boolean;
        hasTokenRegistry: boolean;
        jupiterBase: string;
        jupiterPaths: {
            quote: string;
            swap: string;
        };
        logLevel:
            | "none"
            | "error"
            | "info"
            | "debug";
        raydiumBase: string;
        raydiumPaths: {
            quote: string;
            swap: string;
        };
    };
    ok: boolean;
}>
- Defined in packages/synapse-client-sdk/src/defi/utils.ts:780

jupiterBuildSwapTx

jupiterBuildSwapTx(args): Promise<BuildSwapTxResult>
Build a swap transaction via Jupiter Swap API.
Parameters
- args: {
      asLegacyTransaction?: boolean;
      dynamicSlippageBps?: number;
      payer: string;
      quoteArgs?: JupiterQuoteRequest;
      quoteResponse?: any;
      restrictIntermediateTokens?: string[];
      wrapAndUnwrapSol?: boolean;
  }
  - OptionalasLegacyTransaction?: boolean
  - OptionaldynamicSlippageBps?: number
  - payer: string
  - OptionalquoteArgs?: JupiterQuoteRequest
  - OptionalquoteResponse?: any
  - OptionalrestrictIntermediateTokens?: string[]
  - OptionalwrapAndUnwrapSol?: boolean
Returns Promise<BuildSwapTxResult>
- Defined in packages/synapse-client-sdk/src/defi/utils.ts:403

jupiterQuote

jupiterQuote(params): Promise<QuoteResponse>
Fetch a quote from Jupiter.
Parameters
- params: JupiterQuoteRequest
Returns Promise<QuoteResponse>
- Defined in packages/synapse-client-sdk/src/defi/utils.ts:339

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: string | symbol
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event): ((...args: any[]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
Returns ((...args: any[]) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:20

off

off<T>(event, fn?, context?, once?): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optionalfn: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.off
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:69

on

on<T>(event, fn, context?): this
Add a listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.on
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:40

once

once<T>(event, fn, context?): this
Add a one-time listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.once
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:54

raydiumBuildSwapTx

raydiumBuildSwapTx(args): Promise<BuildSwapTxResult>
Build a Raydium swap transaction.
- Prefer raydium.customSwapBuilder to use the official SDK for precision.
- Fallback to REST aggregator transaction builder if available.
Parameters
- args: RaydiumBuildSwapParams & {
  route?: any;
  }
Returns Promise<BuildSwapTxResult>
- Defined in packages/synapse-client-sdk/src/defi/utils.ts:547

raydiumQuote

raydiumQuote(params): Promise<QuoteResponse>
Fetch a quote from Raydium Aggregator (REST). If you use the Raydium SDK, prefer injecting a custom builder/quoting path via raydium.customSwapBuilder.
Parameters
- params: RaydiumQuoteRequest
Returns Promise<QuoteResponse>
- Defined in packages/synapse-client-sdk/src/defi/utils.ts:486

removeAllListeners

removeAllListeners(event?): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: string | symbol
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event, fn?, context?, once?): this
Remove the listeners of a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optionalfn: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:63

swapWithJupiter

swapWithJupiter(all): Promise<{
signature?: string;
tx?: Transaction | VersionedTransaction;
}>
Parameters
- all: {
      asLegacyTransaction?: boolean;
      dryRun?: boolean;
      dynamicSlippageBps?: number;
      payer: string;
      quoteArgs: JupiterQuoteRequest;
      restrictIntermediateTokens?: string[];
      sendOpts?: {
          maxRetries?: number;
          preflightCommitment?: Commitment;
          skipPreflight?: boolean;
      };
  }
  - OptionalasLegacyTransaction?: boolean
  - OptionaldryRun?: boolean
  - OptionaldynamicSlippageBps?: number
  - payer: string
  - quoteArgs: JupiterQuoteRequest
  - OptionalrestrictIntermediateTokens?: string[]
  - OptionalsendOpts?: {
        maxRetries?: number;
        preflightCommitment?: Commitment;
        skipPreflight?: boolean;
    }
    - OptionalmaxRetries?: number
    - OptionalpreflightCommitment?: Commitment
    - OptionalskipPreflight?: boolean
Returns Promise<{
signature?: string;
tx?: Transaction | VersionedTransaction;
}>
- Defined in packages/synapse-client-sdk/src/defi/utils.ts:744

swapWithRaydium

swapWithRaydium(all): Promise<{
signature?: string;
tx?: Transaction | VersionedTransaction;
}>
Parameters
- all: RaydiumBuildSwapParams & {
      dryRun?: boolean;
      route?: any;
      sendOpts?: {
          maxRetries?: number;
          preflightCommitment?: Commitment;
          skipPreflight?: boolean;
      };
  }
Returns Promise<{
signature?: string;
tx?: Transaction | VersionedTransaction;
}>
- Defined in packages/synapse-client-sdk/src/defi/utils.ts:769

Class SynapseSolanaEngine

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SynapseSolanaEngine

Properties

Staticprefixed

Methods

addListener

Type Parameters

Parameters

Parameters

Returns void

Returns this

decodeBase64Tx

Parameters

Returns Promise<Transaction | VersionedTransaction>

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (string | symbol)[]

executeSwap

Parameters

Returns Promise<{ signature?: string; tx?: Transaction | VersionedTransaction; }>

Requires

getTokenInfo

Parameters

Returns Promise<TokenInfo>

Note

healthCheck

Returns Promise<{ details: { hasCustomBuilder: boolean; hasTokenRegistry: boolean; jupiterBase: string; jupiterPaths: { quote: string; swap: string; }; logLevel: | "none" | "error" | "info" | "debug"; raydiumBase: string; raydiumPaths: { quote: string; swap: string; }; }; ok: boolean; }>

jupiterBuildSwapTx

Parameters

OptionalasLegacyTransaction?: boolean

OptionaldynamicSlippageBps?: number

payer: string

OptionalquoteArgs?: JupiterQuoteRequest

OptionalquoteResponse?: any

OptionalrestrictIntermediateTokens?: string[]

OptionalwrapAndUnwrapSol?: boolean

Returns Promise<BuildSwapTxResult>

jupiterQuote

Parameters

Returns Promise<QuoteResponse>

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ((...args: any[]) => void)[]

off

Type Parameters

Parameters

Parameters

Returns void

Returns this

on

Type Parameters

Parameters

Parameters

Returns void

Returns this

once

Type Parameters

Parameters

Parameters

Returns void

Returns this

raydiumBuildSwapTx

Parameters

Returns Promise<BuildSwapTxResult>

raydiumQuote

`Static`prefixed

Returns Promise<{
signature?: string;
tx?: Transaction | VersionedTransaction;
}>

Returns Promise<{
details: {
hasCustomBuilder: boolean;
hasTokenRegistry: boolean;
jupiterBase: string;
jupiterPaths: {
quote: string;
swap: string;
};
logLevel:
| "none"
| "error"
| "info"
| "debug";
raydiumBase: string;
raydiumPaths: {
quote: string;
swap: string;
};
};
ok: boolean;
}>

`Optional`asLegacyTransaction?: boolean

`Optional`dynamicSlippageBps?: number

`Optional`quoteArgs?: JupiterQuoteRequest

`Optional`quoteResponse?: any

`Optional`restrictIntermediateTokens?: string[]

`Optional`wrapAndUnwrapSol?: boolean

`Optional`asLegacyTransaction?: boolean

`Optional`dryRun?: boolean

`Optional`dynamicSlippageBps?: number

`Optional`restrictIntermediateTokens?: string[]

`Optional`sendOpts?: {
maxRetries?: number;
preflightCommitment?: Commitment;
skipPreflight?: boolean;
}

`Optional`maxRetries?: number

`Optional`preflightCommitment?: Commitment

`Optional`skipPreflight?: boolean

Returns Promise<{
signature?: string;
tx?: Transaction | VersionedTransaction;
}>

Returns Promise<{
signature?: string;
tx?: Transaction | VersionedTransaction;
}>