Skip to main content

teleport-sdk

Home > teleport-sdk

teleport-sdk package

Classes

ClassDescription
TeleportBridgeMain Teleport Bridge implementation

Functions

FunctionDescription
approveSrcGateway(opts)
canMintWithoutOracle(opts)
getAmounts(opts)
getAmountsForTeleportGUID(opts)
getAttestations(opts)
getDefaultDstDomain(srcDomain)Get the default target domain for a given source domain
getDstBalance(opts)
getLikelyDomainId(srcDomain)Convert a domain alias into its DomainId
getRelayFee(opts)
getSdk(domain, signerOrProvider)Get an ethers.js bundle containing contracts and a provider connected to a given domain
getSrcBalance(opts)
getSrcGatewayAllowance(opts)
getTeleportBridge(opts)
getTeleportGuid(txHash, srcDomainProvider, teleportOutboundGatewayInterface)
getTeleportGuidFromTxHash(opts)
initRelayedTeleport(opts)
initTeleport(opts)
isArbitrumMessageInOutbox(txHash, srcDomainProvider, dstDomainProvider)
isOptimismMessageReadyToBeRelayed(txHash, srcChainId, dstChainId, srcDomainProvider, dstDomainProvider)
mintWithOracles(opts)
mintWithoutOracles(opts)
multicall(multicall, calls)
relayArbitrumMessage(txHash, sender, srcDomainProvider, useFakeOutbox, overrides)
relayMintWithOracles(opts)
relayOptimismMessage(txHash, sender, srcChainId, dstChainId, srcDomainProvider, dstDomainProvider, overrides)
requestAndWaitForRelay(relay, receiver, teleportGUID, signatures, relayFee, maxFeePercentage, expiry, to, data, pollingIntervalMs, timeoutMs, onPayloadSigned, onRelayTaskCreated)
requestFaucetDai(opts)
requestRelay(opts)
signAndCreateRelayTask(relay, receiver, teleportGUID, signatures, relayFee, maxFeePercentage, expiry, to, data, onPayloadSigned)Relay a Teleport transaction and wait for the relayer to confirm its execution
signRelay(opts)
signRelayPayload(receiver, teleportGUID, gasFee, maxFeePercentage, expiry)
waitForAttestations(dstDomain, txHash, threshold, isValidAttestation, pollingIntervalMs, teleportGUID, timeoutMs, onNewSignatureReceived)Collect attestations for a transaction from the Oracle network
waitForMint(opts)
waitForMintConfirmation(srcDomain, dstDomain, dstDomainProvider, teleportGUIDorGUIDHash, pollingIntervalMs, timeoutMs)
waitForRelayTask(opts)

Interfaces

InterfaceDescription
CallRepresents a contract call
DomainContext
GetAttestationsOpts
GetRelayFeeOpts
InitTeleportOpts
MintWithOraclesOpts
MintWithoutOracleOpts
RelayParams
SignRelayOpts
TeleportBridgeOptsTeleport Options
TeleportGUIDRepresents a single Teleport Action
TeleportSdk
WaitForMintOpts

Variables

VariableDescription
DEFAULT_RPC_URLS
DOMAIN_CHAIN_IDS
DOMAINSTeleport's supported domains
ORACLE_API_URLS
waitForTxReceipt

Type Aliases

Type AliasDescription
BridgeSettings
DomainDescriptionAccepted aliases for domains
DomainId
RelayRepresents a transaction relay service.
RelayMintWithOraclesOpts
RequestRelayOpts