Skip to Content
API referenceSatellite CoreSrcType AliasesSatelliteAdapter

@tuwaio/satellite-connect-monorepo


SatelliteAdapter

SatelliteAdapter = object

Defined in: packages/satellite-core/src/types.ts:76 

Interface for blockchain network adapters

Remarks

Adapters provide chain-specific implementation for wallet interactions

Properties

checkAndSwitchNetwork()

checkAndSwitchNetwork: (chainId, currentChainId?, updateActiveWallet?) => Promise<void>

Defined in: packages/satellite-core/src/types.ts:106 

Handles network switching for connected wallet

Parameters

chainId

Target chain ID

string | number

currentChainId?

Current chain ID

string | number

updateActiveWallet?

(wallet) => void

Callback to update wallet state

Returns

Promise<void>


checkIsContractWallet()?

optional checkIsContractWallet: ({ address, chainId }) => Promise<boolean>

Defined in: packages/satellite-core/src/types.ts:125 

Optional method to check if address is a smart contract

Parameters

{ address, chainId }
address

string

chainId

string | number

Returns

Promise<boolean>


connect()

connect: ({ walletType, chainId, connectors, }) => Promise<Wallet>

Defined in: packages/satellite-core/src/types.ts:84 

Initiates wallet connection

Parameters

{
walletType, chainId, connectors,

}

chainId

number | string

connectors

Connector[]

walletType

WalletType

Returns

Promise<Wallet>

Promise resolving to connected wallet instance


disconnect()

disconnect: () => Promise<void>

Defined in: packages/satellite-core/src/types.ts:95 

Disconnects current wallet session

Returns

Promise<void>


getAvatar()?

optional getAvatar: (name) => Promise<string | null>

Defined in: packages/satellite-core/src/types.ts:122 

Optional method to get avatar for resolved names

Parameters

name

string

Returns

Promise<string | null>


getConnectors()

getConnectors: () => Promise<{ adapter: OrbitAdapter; connectors: Connector[]; }>

Defined in: packages/satellite-core/src/types.ts:98 

Retrieves available wallet connectors for this adapter

Returns

Promise<{ adapter: OrbitAdapter; connectors: Connector[]; }>


getExplorerUrl()

getExplorerUrl: (url?, chainId?) => string | undefined

Defined in: packages/satellite-core/src/types.ts:116 

Generates blockchain explorer URL

Parameters

url?

string

chainId?

string | number

Returns

string | undefined

Explorer URL or undefined if not available


getName()?

optional getName: (address) => Promise<string | null>

Defined in: packages/satellite-core/src/types.ts:119 

Optional method to resolve ENS-like names

Parameters

address

string

Returns

Promise<string | null>


key

key: OrbitAdapter

Defined in: packages/satellite-core/src/types.ts:78 

Unique identifier for the adapter

Last updated on