Class: TeleportSDK

Constructors

constructor

• new TeleportSDK(): TeleportSDK

Returns

TeleportSDK

Defined in

TeleportSDK.ts:46

Properties

_dapps

• Protected _dapps: Map<string, IDappSDK>

Defined in

TeleportSDK.ts:44

---

config

• config: SDKConfigProvider

Defined in

TeleportSDK.ts:33

---

isInitialized

• Private isInitialized: boolean = false

Defined in

TeleportSDK.ts:40

---

isReadOnly

• isReadOnly: boolean

Defined in

TeleportSDK.ts:38

---

signerOrProvider

• signerOrProvider: ValidProvider

Defined in

TeleportSDK.ts:32

---

validatorAllowedVersion

• validatorAllowedVersion: string

Defined in

TeleportSDK.ts:37

---

validatorAxios

• validatorAxios: AxiosInstance

Defined in

TeleportSDK.ts:34

---

validatorURL

• validatorURL: string

Defined in

TeleportSDK.ts:35

---

validatorVersion

• validatorVersion: string

Defined in

TeleportSDK.ts:36

---

validators

• validators: ValidatorsListChainConfig

Defined in

TeleportSDK.ts:39

Accessors

utils

• get utils(): TeleportHelperUtils

Returns

TeleportHelperUtils

Defined in

TeleportSDK.ts:42

Methods

_configValidators

▸ _configValidators(optionalParams): Promise<void>

Parameters

Name	Type
optionalParams	any

Returns

Promise<void>

Defined in

TeleportSDK.ts:234

---

_getAllValidators

▸ _getAllValidators(validators): string[]

Parameters

Name	Type
validators	any

Returns

string[]

Defined in

TeleportSDK.ts:279

---

_getDefaultConfiguredValidatorVersion

▸ _getDefaultConfiguredValidatorVersion(): Promise<any>

Returns

Promise<any>

Defined in

TeleportSDK.ts:290

---

_setValidatorBasedOnVersion

▸ _setValidatorBasedOnVersion(validatorArray, checkedVersion): Promise<void>

Parameters

Name	Type
validatorArray	any
checkedVersion	string

Returns

Promise<void>

Defined in

TeleportSDK.ts:303

---

configureOptionalParams

▸ configureOptionalParams(optionalParams): void

Parameters

Name	Type
optionalParams	TeleportOptionalParams

Returns

void

Defined in

TeleportSDK.ts:53

---

dapp

▸ dapp<DappType>(name): DappType

Type parameters

Name
DappType

Parameters

Name	Type
name	string

Returns

DappType

Defined in

TeleportSDK.ts:214

---

deliver

▸ deliver(transmission, providerAddress?, options?): PayableCall

Parameters

Name	Type
transmission	DeliverableTransmission
providerAddress?	string
options?	CallOptions

Returns

PayableCall

Defined in

TeleportSDK.ts:113

---

deregisterDapp

▸ deregisterDapp(name): void

Parameters

Name	Type
name	string

Returns

void

Defined in

TeleportSDK.ts:229

---

getChainIdent

▸ getChainIdent(): Promise<string>

Returns

Promise<string>

Defined in

TeleportSDK.ts:52

---

getDeliveries

▸ getDeliveries(dAppId, targetChainId, fromBlock?, beforeBlock?): Promise<Delivery[]>

Parameters

Name	Type
dAppId	string
targetChainId	number
fromBlock?	number
beforeBlock?	number

Returns

Promise<Delivery[]>

Defined in

TeleportSDK.ts:198

---

getIndexedTransmissions

▸ getIndexedTransmissions(dAppId, sourceChainId, fromBlock?, beforeBlock?): Promise<IndexedTransmission[]>

Parameters

Name	Type
dAppId	string
sourceChainId	number
fromBlock?	number
beforeBlock?	number

Returns

Promise<IndexedTransmission[]>

Defined in

TeleportSDK.ts:148

---

getModuleByCollectionAddress

▸ getModuleByCollectionAddress(collectionAddress): Promise<undefined | typeof ERC721RouterSDK | typeof ERC1155RouterSDK>

Parameters

Name	Type
collectionAddress	string

Returns

Promise<undefined | typeof ERC721RouterSDK | typeof ERC1155RouterSDK>

Defined in

TeleportSDK.ts:164

---

getProviderContract

▸ getProviderContract(): any

Returns

any

Defined in

TeleportSDK.ts:135

---

getProviderFee

▸ getProviderFee(«destructured»): Promise<BigNumber>

Parameters

Name	Type
«destructured»	Object
› dAppId	any
› payload	any
› targetChainId	any
› transmissionReceiver	any

Returns

Promise<BigNumber>

Defined in

TeleportSDK.ts:128

---

getProviderSupportedChains

▸ getProviderSupportedChains(): any

Returns

any

Defined in

TeleportSDK.ts:137

---

getServiceFee

▸ getServiceFee(«destructured»): Promise<BigNumber>

Parameters

Name	Type
«destructured»	Object
› dAppId	any
› payload	any
› targetChainId	any
› transmissionReceiver	any

Returns

Promise<BigNumber>

Defined in

TeleportSDK.ts:121

---

getSignatures

▸ getSignatures(dAppId, fromSequenceNumber): Promise<Signature[]>

Parameters

Name	Type
dAppId	string
fromSequenceNumber	number

Returns

Promise<Signature[]>

Defined in

TeleportSDK.ts:177

---

getSignaturesByTimestamp

▸ getSignaturesByTimestamp(dAppId, fromTimestamp): Promise<Signature[]>

Parameters

Name	Type
dAppId	string
fromTimestamp	number

Returns

Promise<Signature[]>

Defined in

TeleportSDK.ts:186

---

getTeleportFee

▸ getTeleportFee(): Promise<BigNumber>

Returns

Promise<BigNumber>

Defined in

TeleportSDK.ts:119

---

getTransmission

▸ getTransmission(transactionId): Promise<IndexedTransmission>

Parameters

Name	Type
transactionId	string

Returns

Promise<IndexedTransmission>

Defined in

TeleportSDK.ts:168

---

getTransmissions

▸ getTransmissions(dAppId, targetChainId): Promise<Transmission[]>

Parameters

Name	Type
dAppId	string
targetChainId	number

Returns

Promise<Transmission[]>

Defined in

TeleportSDK.ts:139

---

initialize

▸ initialize(signerOrProvider, optionalParams?): Promise<void>

Parameters

Name	Type	Description
signerOrProvider	string | Provider | default | Signer	A valid provider for the SDK.
optionalParams?	TeleportOptionalParams	optional parameters used to customize the SDK functionality. Details can be found in TeleportOptionalParams type

Returns

Promise<void>

See

TeleportOptionalParams

Defined in

TeleportSDK.ts:91

---

registerDapp

▸ registerDapp(name, sdkModule): void

Parameters

Name	Type
name	string
sdkModule	IDappSDK

Returns

void

Defined in

TeleportSDK.ts:222

---

setValidator

▸ setValidator(url): void

Parameters

Name	Type
url	any

Returns

void

Defined in

TeleportSDK.ts:274

---

setValidators

▸ setValidators(validatorURL): Promise<void>

Parameters

Name	Type
validatorURL	any

Returns

Promise<void>

Defined in

TeleportSDK.ts:69