Interact with Cross Pool

Create Stake Tx

POST https://api.hotcross.com/cross-pool/{poolAddress}/{pid}/tx/stake

Path Parameters

Name	Type	Description
poolAddress*	String	The smart contract address of the reward pool
pid*	number	The monotonic id of the staking pool

Request Body

Name	Type	Description
user*	String	The user account ($EVM Address)
amount*	String	The amount the user wants to stake (in wei)
chainId*	number	The chain id of the blockchain

200: OK successful operation

{
    "data": "0xe2bbb15800000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000064",
    "gas": 144924
} // Response

500: Internal Server Error Internal server error

{
    // Response
}

Returns

• data - string: The call data of the transaction can be empty for simple value transfers

• gas - number: The gas provided by the transaction

Postman example

Create Unstake Tx

POST https://api.hotcross.com/cross-pool/{poolAddress}/{pid}/tx/unstake

Path Parameters

Name	Type	Description
poolAddress*	String	The smart contract address of the reward pool
pid*	number	The monotonic id of the staking pool

Request Body

Name	Type	Description
user*	String	The user account ($EVM Address)
amount*	String	The amount the user wants to stake (in wei)
chainId*	String	The chain id of the blockchain

200: OK successful operation

{
    "data": "0x441a3e7000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000064",
    "gas": 144924
}

500: Internal Server Error Internal server error

{
    // Response
}

Returns

• data - string: The call data of the transaction can be empty for simple value transfers

• gas - number: The gas provided by the transaction

Postman example

Create Claim Tx

POST https://api.hotcross.com/cross-pool/{poolAddress}/{pid}/tx/claim

Path Parameters

Name	Type	Description
poolAddress*	String	The smart contract address of the reward pool
pid*	number	The monotonic id of the staking pool

Request Body

Name	Type	Description
user*	String	The user account ($EVM Address)
chainId*	number	The chain id of the blockchain

200: OK successful operation

{
    "data": "0xe2bbb15800000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
    "gas": 116354
}

500: Internal Server Error Internal server error

{
    // Response
}

Returns

• data - string: The call data of the transaction can be empty for simple value transfers

• gas - number: The gas provided by the transaction

Postman example

Read user staked amount from the blockchain

POST https://api.hotcross.com/cross-pool/{poolAddress}/{pid}/call/user-staked

Path Parameters

Name	Type	Description
poolAddress*	String	The smart contract address of the reward pool
pid*	number	The monotonic id of the staking pool

Request Body

Name	Type	Description
user*	String	The user account ($EVM Address)
chainId*	numer	The chain id of the blockchain

200: OK successful operation

355426508660415759352

500: Internal Server Error Internal server error

{
    // Response
}

Returns

POST request will return a stringvalue of the staked amount. (in wei)

Postman example

Read user pending rewards amount from the blockchain

POST https://api.hotcross.com/cross-pool/{poolAddress}/{pid}/call/pending-rewards

Path Parameters

Name	Type	Description
poolAddress*	String	The smart contract address of the reward pool
pid*	number	The monotonic id of the staking pool

Request Body

Name	Type	Description
user*	String	The user account ($EVM Address)
chainId*	number	The chain id of the blockchain

200: OK successful operation

12846491302774489381

500: Internal Server Error Internal server error

{
    // Response
}

Returns

POST request will return a string value of the amount of the pending rewards. (in wei)

Postman example

Read total value locked of given pool contract address

GET https://api.hotcross.com/tvl/cross-pool/{poolAddress}

Path Parameters

Name	Type	Description
poolAddress*	string	The smart contract address of the reward pool

Query Parameters

Name	Type	Description
chain*	number	The chain tha the contract address belongs to

200: OK Successful operation

{
    "total": 200,
    "0x4FA7163E153419E0E1064e418dd7A99314Ed27b6": 100
    "0xd6aB096eCE76789620A6aCdC34f8dADD04627DC5": 100
}

404: Not Found Reward pool not found

{
    // Response
}

500: Internal Server Error Internal server error

{
    // Response
}

Responses

• total - number: The total value locked in the reward pool

• staking pool contract address - number: The value locked in a staking pool

Postman example

Read the total amount staked for a token in all cross pools

GET https://api.hotcross.com/tokens/{address}/staked

Path Parameters

Name	Type	Description
address*	String	The address of the token to read the total amount staked for

200: OK Successful operation

{
  "totalStaked": "string"
}

500: Internal Server Error Internal server error

{
    // Response
}

Responses

• totalStaked - string: the amount staked

Postman example