Server
Table of contents
Constructors
Methods
Constructors
constructor
• new Server()
Methods
getBridgingStatus
▸ Static
getBridgingStatus(__namedParameters
): CancelablePromise
<BridgeStatusResponseDTO
>
throws
ApiError
Parameters
Name | Type | Description |
---|---|---|
__namedParameters | Object | - |
__namedParameters.bridgeName? | BridgeName | Name of the bridge used while bridging. |
__namedParameters.fromChainId | number | ID of source chain, e.g Ethereum Mainnet = 1 |
__namedParameters.toChainId | number | ID of destination chain, e.g Ethereum Mainnet = 1 |
__namedParameters.transactionHash | string | Transaction hash originating from the source chain while bridging assets. |
Returns
CancelablePromise
<BridgeStatusResponseDTO
>
BridgeStatusResponseDTO Returns the status of the bridging transaction if completed or pending.
Defined in
socket-v2-sdk/src/client/services/Server.ts:105
getGasPrice
▸ Static
getGasPrice(__namedParameters
): CancelablePromise
<GasPriceResponseDTO
>
throws
ApiError
Parameters
Name | Type | Description |
---|---|---|
__namedParameters | Object | - |
__namedParameters.chainId | ChainId | ID of chain, e.g Ethereum Mainnet = 1 |
Returns
CancelablePromise
<GasPriceResponseDTO
>
GasPriceResponseDTO Current gas prices for a chain
Defined in
socket-v2-sdk/src/client/services/Server.ts:42
getHealth
▸ Static
getHealth(): CancelablePromise
<HealthResponseDTO
>
throws
ApiError
Returns
CancelablePromise
<HealthResponseDTO
>
HealthResponseDTO Health Check for Fund Movr API
Defined in
socket-v2-sdk/src/client/services/Server.ts:20
getHealthRpc
▸ Static
getHealthRpc(): CancelablePromise
<any
>
throws
ApiError
Returns
CancelablePromise
<any
>
any Health Check for Fund Movr API RPCS
Defined in
socket-v2-sdk/src/client/services/Server.ts:31
getSingleTx
▸ Static
getSingleTx(__namedParameters
): CancelablePromise
<SingleTxOutputDTO
>
throws
ApiError
Parameters
Name | Type |
---|---|
__namedParameters | Object |
__namedParameters.requestBody | SingleTxDTO |
Returns
CancelablePromise
<SingleTxOutputDTO
>
SingleTxOutputDTO Get the tx details for the route.
Defined in
socket-v2-sdk/src/client/services/Server.ts:85
getTokenPrice
▸ Static
getTokenPrice(__namedParameters
): CancelablePromise
<TokenPriceResponseDTO
>
throws
ApiError
Parameters
Name | Type | Description |
---|---|---|
__namedParameters | Object | - |
__namedParameters.chainId | ChainId | ID of chain, e.g Ethereum Mainnet = 1 |
__namedParameters.tokenAddress | string | Token contract address on network, e.g USDC on Ethereum Mainnet |
Returns
CancelablePromise
<TokenPriceResponseDTO
>
TokenPriceResponseDTO Returns price of token for a given chain
Defined in
socket-v2-sdk/src/client/services/Server.ts:61
getTransactionReceipt
▸ Static
getTransactionReceipt(__namedParameters
): CancelablePromise
<TransactionReceiptResponseDTO
>
throws
ApiError
Parameters
Name | Type | Description |
---|---|---|
__namedParameters | Object | - |
__namedParameters.chainId | ChainId | ID of source chain, e.g Ethereum Mainnet = 1 |
__namedParameters.transactionHash | string | Transaction hash originating from the source chain while bridging assets. |
Returns
CancelablePromise
<TransactionReceiptResponseDTO
>
TransactionReceiptResponseDTO Returns the receipt of the transaction.