SatelliteAdapter<C, W>
SatelliteAdapter<
C,W> =BaseAdapter&object
Defined in: types.ts:79
Contract of a chain adapter used by createSatelliteConnectStore. satelliteEVMAdapter from
@tuwaio/satellite-evm and satelliteSolanaAdapter from @tuwaio/satellite-solana implement it; implement it
yourself to add another chain family.
It extends BaseAdapter from @tuwaio/orbit-core: getExplorerUrl(url?, chainId?) returns an explorer link (or
undefined), and the optional getName, getAvatar and getAddress resolve names such as ENS or SNS.
Type Declaration
checkAndSwitchNetwork
checkAndSwitchNetwork: (
chainId,currentChainId?,updateActiveConnector?) =>Promise<void>
Moves the connection to chainId when it is on another chain. EVM: asks the wallet to switch networks. Solana:
there is no wallet request; the connection’s chainId and rpcURL are updated through updateActiveConnector.
Parameters
chainId
string | number
Target chain.
currentChainId?
string | number
Chain the connection is on now.
updateActiveConnector?
(connector) => void
Merges fields into the connection in the store.
Returns
Promise<void>
Resolves when the switch is done.
Throws
When the wallet rejects or cannot switch.
checkIsContractAddress?
optionalcheckIsContractAddress?: (params) =>Promise<boolean>
Checks whether an address is a smart contract. The store calls it after every new connection and saves the
result in isContractAddress.
Parameters
params
Address and chain to check.
address
string
Account to check.
chainId
string | number
Chain to check it on.
Returns
Promise<boolean>
true for a contract account.
connect
connect: (
params) =>Promise<Connector<W>>
Asks the wallet of params.connectorType to connect and returns the new connection.
Parameters
params
Connection target.
chainId
number | string
Chain to connect to (EVM chain ID, or Solana cluster moniker or solana: chain ID).
connectorType
ConnectorType
Connector to connect, for example "evm:metamask".
Returns
Promise<Connector<W>>
The connection.
Throws
When no wallet matches connectorType or the wallet rejects the request.
disconnect
disconnect: (
activeConnector?) =>Promise<void>
Disconnects the wallet of activeConnector, or every wallet of this adapter when it is omitted.
Parameters
activeConnector?
Connector<W>
The connection to disconnect.
Returns
Promise<void>
Resolves when the wallet has been asked to disconnect.
getBalance
getBalance: (
address,chainId) =>Promise<{symbol:string;value:string; }>
Reads the native balance of an address over RPC.
Parameters
address
string
Account to read.
chainId
number | string
Chain to read it on.
Returns
Promise<{ symbol: string; value: string; }>
The balance as a decimal string in whole units (for example "1.5") and the currency symbol.
Throws
When the RPC request fails.
getConnectors
getConnectors: () =>
object
Lists the wallets this adapter can connect to right now.
Returns
The adapter key and its connectors.
adapter
adapter:
OrbitAdapter
The adapter key.
connectors
connectors:
C[]
The wallets available now.
getSafeConnectorChainId?
optionalgetSafeConnectorChainId?: () =>Promise<number|undefined>
Returns the chain of the Safe connector. initializeAutoConnect calls it when the app runs in an HTTPS iframe and
treats a chain ID as “inside Safe{Wallet}”, so it must resolve to a chain ID only there; a rejection is treated
like undefined.
Returns
Promise<number | undefined>
The chain ID, or undefined when there is no Safe connector.
key
key:
OrbitAdapter
Chain family of the adapter. The store picks the adapter by the prefix of a connectorType.
switchConnection?
optionalswitchConnection?: (connectorType) =>Promise<void>
Makes an already connected wallet the active one in the wallet library.
Parameters
connectorType
ConnectorType
Connector to activate.
Returns
Promise<void>
Resolves when the wallet is active.
Throws
When the connector is not found or cannot be activated.
Type Parameters
C
C
Type of the wallet connectors returned by getConnectors (for example a wagmi Connector).
W
W extends BaseConnector = BaseConnector
Chain-specific connection type returned by connect.