Interact with Cross Yield

Create deposit Tx for Cross Yield

POST https://api.hotcross.com/cross-yield/{contractAddress}/tx/deposit

Path Parameters

Name	Type	Description
contractAddress*	String	The smart contract address of the cross yield vault

Request Body

Name	Type	Description
user*	String	The user account($EVM Address)
amount*	String	The amount the user wants to deposit (in the lowest denomination)
chainId*	number	The chain id of the blockchain you want to read the pools from Ethereum: 1 BNB Smart Chain: 56 Avalanche C-Chain: 43114

200: OK Successful operation

{
    "data": "0xb6b55f25000000000000000000000000000000000000000000000000000000000000000b",
    "gas": 719149
}

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 deposit tx for cross yield that will deposit the entire users balance

POST https://api.hotcross.com/cross-yield/{contractAddress}/tx/deposit-all

Path Parameters

Name	Type	Description
contactAddress*	String	The smart contract address of the cross yield vault

Request Body

Name	Type	Description
user*	String	The user account($EVM Address)
chainId*	number	The chain id of the blockchain you want to read the pools from Ethereum: 1 BNB Smart Chain: 56 Avalanche C-Chain: 43114

200: OK Successful operation

{
    "data": "0xde5f6268",
    "gas": 690738
}

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 zap in Tx for cross yield

POST https://api.hotcross.com/cross-yield/{contractAddress}/tx/zap-in

Path Parameters

Name	Type	Description
contractAddress*	String	The smart contract address of the cross yield vault

Request Body

Name	Type	Description
user*	String	The user account($EVM Address)
tokenInAmount*	String	The amount the user wants to zap in (in the lowest denomination)
crossYieldZapAddress*	String	The address of the cross yield zap contract
slippage*	number	A number representing a percentage for the maximum allowed slippage when performing the zap
chainId*	number	The chain id of the blockchain you want to read the pools from Ethereum: 1 BNB Smart Chain: 56 Avalanche C-Chain: 43114

200: OK successful operation

{
    "data": "0x72f8b6cd0000000000000000000000009bff65a94c56f7173406f9b417b2bb81bf233965000000000000000000000000000000000000000000000000840a31eb4962a8e6000000000000000000000000bb4cdb9cbd36b01bd1cbaebf2de08d9173bc095c000000000000000000000000000000000000000000000000002386f26fc10000",
    "gas": 721304
}

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 BNB zap in tx for Cross Yield

POST https://api.hotcross.com/cross-yield/{contractAddress}/tx/zap-in-bnb

Path Parameters

Name	Type	Description
contractAddress*	String	The smart contract address of the cross yield vault

Request Body

Name	Type	Description
user*	String	The user account($EVM Address)
tokenInAmount*	String	The amount the user wants to zap in (in the lowest denomination)
crossYieldZapAddress*	String	The address of the cross yield zap contract
slippage*	number	A number representing a percentage for the maximum allowed slippage when performing the zap
chainId*	number	The chain id of the blockchain you want to read the pools from Ethereum: 1 BNB Smart Chain: 56 Avalanche C-Chain: 43114

200: OK successful operation

{
  "data": "string",
  "gas": 0
}

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 Cross Yield withdraw tx

POST https://api.hotcross.com/cross-yield/{contractAddress}/tx/withdraw

Path Parameters

Name	Type	Description
contractAddress*	String	The smart contract address of the cross yield vault

Request Body

Name	Type	Description
user*	String	The user account($EVM Address)
tokenAmount*	String	The amount of farming tokens the user wants to withdraw (in the lowest denomination). Only one of tokenAmount or ibtAmount needs to be included
ibtAmount*	String	The amount of IBT tokens the user wants to withdraw (in the lowest denomination). Only one of tokenAmount or ibtAmount needs to be included
chainId*	number	The chain id of the blockchain you want to read the pools from Ethereum: 1 BNB Smart Chain: 56 Avalanche C-Chain: 43114

200: OK successful operation

{
    "data": "0x2e1a7d4d0000000000000000000000000000000000000000000000000000000000000064",
    "gas": 190448
}

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 Cross Yield withdraw all tx

POST https://api.hotcross.com/cross-yield/{contractAddress}/tx/withdraw-all

Path Parameters

Name	Type	Description
contractAddress*	String	The smart contract address of the cross yield vault

Request Body

Name	Type	Description
user*	String	The user account($EVM Address)
chainId*	number	The chain id of the blockchain you want to read the pools from Ethereum: 1 BNB Smart Chain: 56 Avalanche C-Chain: 43114

200: OK successful operation

{
    "data": "0x853828b6",
    "gas": 325413
}

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 Cross Yield harvest tx

POST https://api.hotcross.com/cross-yield/{contractAddress}/tx/harvest

Path Parameters

Name	Type	Description
contractAddress*	String	The smart contract address of the cross yield strategy contract

Request Body

Name	Type	Description
user*	String	The user account($EVM Address)
chainId*	number	The chain id of the blockchain you want to read the pools from Ethereum: 1 BNB Smart Chain: 56 Avalanche C-Chain: 43114

200: OK successful operation

{
  "user": "string",
  "chainId": 56
}

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 deposited amount from the blockchain

POST https://api.hotcross.com/cross-yield/{contractAddress}/call/user-deposited

Path Parameters

Name	Type	Description
contractAddress*	String	The smart contract address of the cross yield vault

Request Body

Name	Type	Description
user*	String	The user account($EVM Address)
chainId*	number	The chain id of the blockchain you want to read the pools from Ethereum: 1 BNB Smart Chain: 56 Avalanche C-Chain: 43114

200: OK successful operation

 4093514643865158608020

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 pending fees in WBNB that will be given as a reward to the user for harvesting

POST https://api.hotcross.com/cross-yield/{strategyAddress}/call/pending-fees

Path Parameters

Name	Type	Description
strategyAddress*	String	The smart contract address of the cross yield strategy contract

Request Body

Name	Type	Description
chainId*	number	The chain id of the blockchain you want to read the pools from Ethereum: 1 BNB Smart Chain: 56 Avalanche C-Chain: 43114

200: OK successful operation

2783680589370196

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