Preparing search index...
The search index is not available
Hop Protocol v2 SDK - v0.0.1-beta.21
Hop Protocol v2 SDK
HubConnector
Class HubConnector
Hierarchy
Base
HubConnector
Index
Constructors
constructor
Properties
batch
Blocks
contract
Addresses
gas
Price
Multiplier
hub
Chain
Id
l1
Chain
Id
network
signers
Or
Providers
Accessors
populate
Transaction
utils
Methods
connect
Targets
get
Chain
Ids
Supported
By
Token
Symbol
get
Color
For
Chain
Id
get
Config
Address
get
Config
Start
Block
get
Connector
Address
From
Receipt
get
Connector
Address
From
Tx
get
Connector
Deployed
Events
get
Contract
Addresses
get
Contract
Exists
get
Default
Provider
get
Default
Providers
get
Ethers
Web3
Signer
get
Explorer
Api
Base
Url
get
Hub
Chain
Id
get
Hub
Connector
Contract
Address
get
Provider
get
Signer
get
Signer
Address
get
Signer
Or
Provider
get
Signer
Provider
Chain
Id
get
Supported
Chain
Ids
get
Supported
Token
Symbols
get
Supported
Token
Symbols
By
Chain
Id
get
Token
Address
By
Token
Symbol
get
Token
Symbol
By
Token
Address
get
Tx
Overrides
send
Transaction
set
Contract
Addresses
set
Explorer
Api
Base
Url
set
Hub
Chain
Id
set
Provider
set
Provider
Url
set
Provider
Urls
set
Providers
throw
Error
get
Default
Provider
get
Default
Providers
Constructors
constructor
new
Hub
Connector
(
config
)
:
HubConnector
Parameters
config
:
BaseConfig
Returns
HubConnector
Properties
batch
Blocks
batch
Blocks
:
number
contract
Addresses
contract
Addresses
:
Addresses
gas
Price
Multiplier
gas
Price
Multiplier
:
number
hub
Chain
Id
hub
Chain
Id
:
string
l1
Chain
Id
l1
Chain
Id
:
number
network
network
:
string
signers
Or
Providers
signers
Or
Providers
:
SignersOrProviders
Accessors
populate
Transaction
get
populateTransaction
(
)
:
{
connectTargets
:
(
(
__namedParameters
,
txOverrides
?
)
=>
Promise
<
TransactionRequest
>
)
;
}
Returns
{
connectTargets
:
(
(
__namedParameters
,
txOverrides
?
)
=>
Promise
<
TransactionRequest
>
)
;
}
connect
Targets
:
(
(
__namedParameters
,
txOverrides
?
)
=>
Promise
<
TransactionRequest
>
)
(
__namedParameters
,
txOverrides
?
)
:
Promise
<
TransactionRequest
>
Parameters
__namedParameters
:
ConnectTargetsInput
txOverrides
:
TxOverrides
= {}
Returns
Promise
<
TransactionRequest
>
utils
get
utils
(
)
:
{
estimateGas
:
(
(
provider
,
tx
)
=>
Promise
<
BigNumber
>
)
;
generateZeroBytes32
:
(
(
)
=>
string
)
;
getAddressExplorerUrl
:
(
(
address
,
chainId
)
=>
string
)
;
getBumpedGasPrice
:
(
(
provider
,
percent
)
=>
Promise
<
BigNumber
>
)
;
getChainInfo
:
(
(
chainId
)
=>
any
)
;
getChainSlug
:
(
(
chainId
)
=>
string
)
;
getConnectedChainId
:
(
(
provider
)
=>
Promise
<
BigNumber
>
)
;
getGasPrice
:
(
(
signerOrProvider
)
=>
Promise
<
BigNumber
>
)
;
getLogoForChainId
:
(
(
chainId
)
=>
string
)
;
getLogoForChainSlug
:
(
(
chainSlug
)
=>
string
)
;
getLogoForTokenSymbol
:
(
(
tokenSymbol
)
=>
string
)
;
getTokenExplorerUrl
:
(
(
address
,
chainId
)
=>
string
)
;
getTransactionHashExplorerUrl
:
(
(
txHash
,
chainId
)
=>
string
)
;
isContractError
:
(
(
err
)
=>
boolean
)
;
isValidAddress
:
(
(
address
)
=>
boolean
)
;
isValidBytes
:
(
(
bytes
)
=>
boolean
)
;
isValidBytes32
:
(
(
hash
)
=>
boolean
)
;
isValidChainId
:
(
(
chainId
)
=>
boolean
)
;
isValidFilterBlock
:
(
(
blockTag
)
=>
boolean
)
;
isValidNumericValue
:
(
(
value
)
=>
boolean
)
;
isValidObject
:
(
(
obj
)
=>
boolean
)
;
isValidTxHash
:
(
(
txHash
)
=>
boolean
)
;
switchChain
:
(
(
chainId
,
provider
)
=>
Promise
<
void
>
)
;
willTransactionFail
:
(
(
provider
,
tx
)
=>
Promise
<
boolean
>
)
;
}
Returns
{
estimateGas
:
(
(
provider
,
tx
)
=>
Promise
<
BigNumber
>
)
;
generateZeroBytes32
:
(
(
)
=>
string
)
;
getAddressExplorerUrl
:
(
(
address
,
chainId
)
=>
string
)
;
getBumpedGasPrice
:
(
(
provider
,
percent
)
=>
Promise
<
BigNumber
>
)
;
getChainInfo
:
(
(
chainId
)
=>
any
)
;
getChainSlug
:
(
(
chainId
)
=>
string
)
;
getConnectedChainId
:
(
(
provider
)
=>
Promise
<
BigNumber
>
)
;
getGasPrice
:
(
(
signerOrProvider
)
=>
Promise
<
BigNumber
>
)
;
getLogoForChainId
:
(
(
chainId
)
=>
string
)
;
getLogoForChainSlug
:
(
(
chainSlug
)
=>
string
)
;
getLogoForTokenSymbol
:
(
(
tokenSymbol
)
=>
string
)
;
getTokenExplorerUrl
:
(
(
address
,
chainId
)
=>
string
)
;
getTransactionHashExplorerUrl
:
(
(
txHash
,
chainId
)
=>
string
)
;
isContractError
:
(
(
err
)
=>
boolean
)
;
isValidAddress
:
(
(
address
)
=>
boolean
)
;
isValidBytes
:
(
(
bytes
)
=>
boolean
)
;
isValidBytes32
:
(
(
hash
)
=>
boolean
)
;
isValidChainId
:
(
(
chainId
)
=>
boolean
)
;
isValidFilterBlock
:
(
(
blockTag
)
=>
boolean
)
;
isValidNumericValue
:
(
(
value
)
=>
boolean
)
;
isValidObject
:
(
(
obj
)
=>
boolean
)
;
isValidTxHash
:
(
(
txHash
)
=>
boolean
)
;
switchChain
:
(
(
chainId
,
provider
)
=>
Promise
<
void
>
)
;
willTransactionFail
:
(
(
provider
,
tx
)
=>
Promise
<
boolean
>
)
;
}
estimate
Gas
:
(
(
provider
,
tx
)
=>
Promise
<
BigNumber
>
)
(
provider
,
tx
)
:
Promise
<
BigNumber
>
Parameters
provider
:
Provider
tx
:
TransactionRequest
Returns
Promise
<
BigNumber
>
generate
Zero
Bytes32
:
(
(
)
=>
string
)
(
)
:
string
Returns
string
get
Address
Explorer
Url
:
(
(
address
,
chainId
)
=>
string
)
(
address
,
chainId
)
:
string
Parameters
address
:
string
chainId
:
BigNumberish
Returns
string
get
Bumped
Gas
Price
:
(
(
provider
,
percent
)
=>
Promise
<
BigNumber
>
)
(
provider
,
percent
)
:
Promise
<
BigNumber
>
Parameters
provider
:
Provider
percent
:
number
Returns
Promise
<
BigNumber
>
get
Chain
Info
:
(
(
chainId
)
=>
any
)
(
chainId
)
:
any
Parameters
chainId
:
BigNumberish
Returns
any
get
Chain
Slug
:
(
(
chainId
)
=>
string
)
(
chainId
)
:
string
Parameters
chainId
:
BigNumberish
Returns
string
get
Connected
Chain
Id
:
(
(
provider
)
=>
Promise
<
BigNumber
>
)
(
provider
)
:
Promise
<
BigNumber
>
Parameters
provider
:
Provider
Returns
Promise
<
BigNumber
>
get
Gas
Price
:
(
(
signerOrProvider
)
=>
Promise
<
BigNumber
>
)
(
signerOrProvider
)
:
Promise
<
BigNumber
>
Parameters
signerOrProvider
:
Provider
|
Signer
Returns
Promise
<
BigNumber
>
get
Logo
For
Chain
Id
:
(
(
chainId
)
=>
string
)
(
chainId
)
:
string
Parameters
chainId
:
BigNumberish
Returns
string
get
Logo
For
Chain
Slug
:
(
(
chainSlug
)
=>
string
)
(
chainSlug
)
:
string
Parameters
chainSlug
:
string
Returns
string
get
Logo
For
Token
Symbol
:
(
(
tokenSymbol
)
=>
string
)
(
tokenSymbol
)
:
string
Parameters
tokenSymbol
:
string
Returns
string
get
Token
Explorer
Url
:
(
(
address
,
chainId
)
=>
string
)
(
address
,
chainId
)
:
string
Parameters
address
:
string
chainId
:
BigNumberish
Returns
string
get
Transaction
Hash
Explorer
Url
:
(
(
txHash
,
chainId
)
=>
string
)
(
txHash
,
chainId
)
:
string
Parameters
txHash
:
string
chainId
:
BigNumberish
Returns
string
is
Contract
Error
:
(
(
err
)
=>
boolean
)
(
err
)
:
boolean
Parameters
err
:
unknown
Returns
boolean
is
Valid
Address
:
(
(
address
)
=>
boolean
)
(
address
)
:
boolean
Parameters
address
:
string
Returns
boolean
is
Valid
Bytes
:
(
(
bytes
)
=>
boolean
)
(
bytes
)
:
boolean
Parameters
bytes
:
string
Returns
boolean
is
Valid
Bytes32
:
(
(
hash
)
=>
boolean
)
(
hash
)
:
boolean
Parameters
hash
:
string
Returns
boolean
is
Valid
Chain
Id
:
(
(
chainId
)
=>
boolean
)
(
chainId
)
:
boolean
Parameters
chainId
:
BigNumberish
Returns
boolean
is
Valid
Filter
Block
:
(
(
blockTag
)
=>
boolean
)
(
blockTag
)
:
boolean
Parameters
blockTag
:
string
|
number
Returns
boolean
is
Valid
Numeric
Value
:
(
(
value
)
=>
boolean
)
(
value
)
:
boolean
Parameters
value
:
null
|
object
|
BigNumberish
Returns
boolean
is
Valid
Object
:
(
(
obj
)
=>
boolean
)
(
obj
)
:
boolean
Parameters
obj
:
any
Returns
boolean
is
Valid
Tx
Hash
:
(
(
txHash
)
=>
boolean
)
(
txHash
)
:
boolean
Parameters
txHash
:
string
Returns
boolean
switch
Chain
:
(
(
chainId
,
provider
)
=>
Promise
<
void
>
)
(
chainId
,
provider
)
:
Promise
<
void
>
Parameters
chainId
:
BigNumberish
provider
:
Provider
Returns
Promise
<
void
>
will
Transaction
Fail
:
(
(
provider
,
tx
)
=>
Promise
<
boolean
>
)
(
provider
,
tx
)
:
Promise
<
boolean
>
Parameters
provider
:
Provider
tx
:
TransactionRequest
Returns
Promise
<
boolean
>
Methods
connect
Targets
connect
Targets
(
input
,
txOverrides
?
)
:
Promise
<
TransactionResponse
>
Parameters
input
:
ConnectTargetsInput
txOverrides
:
TxOverrides
= {}
Returns
Promise
<
TransactionResponse
>
get
Chain
Ids
Supported
By
Token
Symbol
get
Chain
Ids
Supported
By
Token
Symbol
(
tokenSymbol
)
:
string
[]
Parameters
tokenSymbol
:
string
Returns
string
[]
get
Color
For
Chain
Id
get
Color
For
Chain
Id
(
chainId
)
:
string
Parameters
chainId
:
BigNumberish
Returns
string
get
Config
Address
get
Config
Address
(
chainId
,
key
)
:
string
Parameters
chainId
:
BigNumberish
key
:
string
Returns
string
get
Config
Start
Block
get
Config
Start
Block
(
chainId
)
:
number
Parameters
chainId
:
BigNumberish
Returns
number
get
Connector
Address
From
Receipt
get
Connector
Address
From
Receipt
(
receipt
)
:
Promise
<
string
>
Parameters
receipt
:
TransactionReceiptWithEvents
Returns
Promise
<
string
>
get
Connector
Address
From
Tx
get
Connector
Address
From
Tx
(
tx
)
:
Promise
<
string
>
Parameters
tx
:
TransactionResponse
Returns
Promise
<
string
>
get
Connector
Deployed
Events
get
Connector
Deployed
Events
(
__namedParameters
)
:
Promise
<
ConnectorDeployed
[]
>
Parameters
__namedParameters
:
GetEventsInput
Returns
Promise
<
ConnectorDeployed
[]
>
get
Contract
Addresses
get
Contract
Addresses
(
)
:
Addresses
Returns
Addresses
get
Contract
Exists
get
Contract
Exists
(
address
,
provider
)
:
Promise
<
boolean
>
Parameters
address
:
string
provider
:
Provider
Returns
Promise
<
boolean
>
get
Default
Provider
get
Default
Provider
(
chainId
)
:
Provider
Parameters
chainId
:
BigNumberish
Returns
Provider
get
Default
Providers
get
Default
Providers
(
)
:
SignersOrProviders
Returns
SignersOrProviders
get
Ethers
Web3
Signer
get
Ethers
Web3
Signer
(
signer
)
:
Signer
Parameters
signer
:
any
Returns
Signer
get
Explorer
Api
Base
Url
get
Explorer
Api
Base
Url
(
)
:
string
Returns
string
get
Hub
Chain
Id
get
Hub
Chain
Id
(
)
:
string
Returns
string
get
Hub
Connector
Contract
Address
get
Hub
Connector
Contract
Address
(
chainId
)
:
string
Parameters
chainId
:
BigNumberish
Returns
string
get
Provider
get
Provider
(
chainId
)
:
null
|
Provider
Parameters
chainId
:
BigNumberish
Returns
null
|
Provider
get
Signer
get
Signer
(
chainId
)
:
Promise
<
null
|
Signer
>
Parameters
chainId
:
BigNumberish
Returns
Promise
<
null
|
Signer
>
get
Signer
Address
get
Signer
Address
(
chainId
)
:
Promise
<
null
|
string
>
Parameters
chainId
:
BigNumberish
Returns
Promise
<
null
|
string
>
get
Signer
Or
Provider
get
Signer
Or
Provider
(
chainId
)
:
Promise
<
Provider
|
Signer
>
Parameters
chainId
:
BigNumberish
Returns
Promise
<
Provider
|
Signer
>
get
Signer
Provider
Chain
Id
get
Signer
Provider
Chain
Id
(
chainId
)
:
Promise
<
BigNumber
>
Parameters
chainId
:
BigNumberish
Returns
Promise
<
BigNumber
>
get
Supported
Chain
Ids
get
Supported
Chain
Ids
(
)
:
string
[]
Returns
string
[]
get
Supported
Token
Symbols
get
Supported
Token
Symbols
(
)
:
string
[]
Returns
string
[]
get
Supported
Token
Symbols
By
Chain
Id
get
Supported
Token
Symbols
By
Chain
Id
(
chainId
)
:
string
[]
Parameters
chainId
:
BigNumberish
Returns
string
[]
get
Token
Address
By
Token
Symbol
get
Token
Address
By
Token
Symbol
(
chainId
,
tokenSymbol
)
:
string
Parameters
chainId
:
BigNumberish
tokenSymbol
:
string
Returns
string
get
Token
Symbol
By
Token
Address
get
Token
Symbol
By
Token
Address
(
chainId
,
tokenAddress
)
:
string
Parameters
chainId
:
BigNumberish
tokenAddress
:
string
Returns
string
get
Tx
Overrides
get
Tx
Overrides
(
fromChainId
,
toChainId
)
:
Promise
<
TxOverrides
>
Parameters
fromChainId
:
BigNumberish
toChainId
:
BigNumberish
Returns
Promise
<
TxOverrides
>
send
Transaction
send
Transaction
(
transactionRequest
,
chainId
?
,
customSigner
?
)
:
Promise
<
TransactionResponse
>
Parameters
transactionRequest
:
TransactionRequest
Optional
chainId
:
BigNumberish
Optional
customSigner
:
null
|
Signer
Returns
Promise
<
TransactionResponse
>
set
Contract
Addresses
set
Contract
Addresses
(
contractAddresses
)
:
void
Parameters
contractAddresses
:
Addresses
Returns
void
set
Explorer
Api
Base
Url
set
Explorer
Api
Base
Url
(
url
)
:
void
Parameters
url
:
string
Returns
void
set
Hub
Chain
Id
set
Hub
Chain
Id
(
newChainId
)
:
void
Parameters
newChainId
:
BigNumberish
Returns
void
set
Provider
set
Provider
(
chainId
,
provider
)
:
void
Parameters
chainId
:
BigNumberish
provider
:
Provider
|
Signer
Returns
void
set
Provider
Url
set
Provider
Url
(
chainId
,
url
)
:
void
Parameters
chainId
:
BigNumberish
url
:
string
|
string
[]
Returns
void
set
Provider
Urls
set
Provider
Urls
(
signersOrProvidersUrls
)
:
void
Parameters
signersOrProvidersUrls
:
Record
<
string
,
string
|
string
[]
>
Returns
void
set
Providers
set
Providers
(
signersOrProviders
)
:
void
Parameters
signersOrProviders
:
SignersOrProviders
Returns
void
throw
Error
throw
Error
(
err
)
:
unknown
Parameters
err
:
unknown
Returns
unknown
Static
get
Default
Provider
get
Default
Provider
(
chainId
)
:
Provider
Parameters
chainId
:
BigNumberish
Returns
Provider
Static
get
Default
Providers
get
Default
Providers
(
network
)
:
SignersOrProviders
Parameters
network
:
string
Returns
SignersOrProviders
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
constructor
batch
Blocks
contract
Addresses
gas
Price
Multiplier
hub
Chain
Id
l1
Chain
Id
network
signers
Or
Providers
populate
Transaction
utils
connect
Targets
get
Chain
Ids
Supported
By
Token
Symbol
get
Color
For
Chain
Id
get
Config
Address
get
Config
Start
Block
get
Connector
Address
From
Receipt
get
Connector
Address
From
Tx
get
Connector
Deployed
Events
get
Contract
Addresses
get
Contract
Exists
get
Default
Provider
get
Default
Providers
get
Ethers
Web3
Signer
get
Explorer
Api
Base
Url
get
Hub
Chain
Id
get
Hub
Connector
Contract
Address
get
Provider
get
Signer
get
Signer
Address
get
Signer
Or
Provider
get
Signer
Provider
Chain
Id
get
Supported
Chain
Ids
get
Supported
Token
Symbols
get
Supported
Token
Symbols
By
Chain
Id
get
Token
Address
By
Token
Symbol
get
Token
Symbol
By
Token
Address
get
Tx
Overrides
send
Transaction
set
Contract
Addresses
set
Explorer
Api
Base
Url
set
Hub
Chain
Id
set
Provider
set
Provider
Url
set
Provider
Urls
set
Providers
throw
Error
get
Default
Provider
get
Default
Providers
Visit App
V2 Playground
Explorer
Hop Protocol v2 SDK - v0.0.1-beta.21
EventName
MessengerEventName
RailsGatewayEventName
RailsPathEventName
TransferState
BonderPreferenceEventFetcher
ClaimPushedEventFetcher
ClaimReaddedEventFetcher
ClaimRemovedEventFetcher
ConfigError
ContractFunctionRevertedError
CustomError
Hop
HubConnector
InputError
InsufficientApprovalError
InsufficientBalanceError
Messenger
PathInitializedEventFetcher
PriceFeed
RailsGateway
Loading...