Defi Module

Defi module handles operations related to DeFi protocols, including farms and whitelisted tokens.

To learn more about how to use the AI Agent SDK to interact with the wallet module, please visit AI Agent SDK Defi Operations.

7.1 Get Whitelisted Tokens

Fetches whitelisted tokens for a specific DeFi protocol.

Function Name

get_whitelisted_tokens

Arguments

protocol (DefiProtocol): The DeFi protocol (e.g., DefiProtocol.H2, DefiProtocol.VVS)

Example Code

from crypto_com_developer_platform_client import Defi, DefiProtocol

tokens = Defi.get_whitelisted_tokens(DefiProtocol.H2)
print(tokens)

Returns

List of whitelisted tokens for the project.

Example Return

{'status': 'Success', 'data': [{'id': example-id, 'name': 'example-name', 'symbol': 'example-symbol', 'address': 'example-address', 'decimal': example-decimal, 'link': 'example-link', 'isSwappable': example-boolean, 'logoImagePngUrl': 'example-url', 'logoImageSvgUrl': 'example-url', 'chain': 'example-chain-name', 'chainId': example-chain-id}, ... ]}

Function Name

getWhitelistedTokens

Arguments

{DefiProtocol} protocol: The DeFi protocol to fetch tokens for.

Example Code

import { Defi, DefiProtocol } from '@crypto.com/developer-platform-client';

try {
  const tokens = await Defi.getWhitelistedTokens(DefiProtocol.H2);
  console.log(tokens);
}
  catch(err) {
  console.log(err);
}

Returns

{Promise<ApiResponse<WhitelistedToken[]>>}: A promise that resolves to the whitelisted tokens.

Errors

{Error}: Throws an error if the request fails.

Example Return

{
  status: 'Success',
  data: [
    {
      id: example-id,
      name: example-name,
      symbol: 'example-symbol,
      address: example-address,
      decimal: example-decimal,
      link: example-link,
      isSwappable: example-boolean,
      logoImagePngUrl: example-url,
      logoImageSvgUrl: example-url,
      chain: example-chain-name,
      chainId: example-chain-id
    }
    ...
  ]
}

7.2 Get All Farms

Fetches all farms for a specific DeFi protocol.

Function Name

get_all_farms

Arguments

protocol (DefiProtocol): The DeFi protocol (e.g., DefiProtocol.H2, DefiProtocol.VVS)

Example Code

from crypto_com_developer_platform_client import Defi, DefiProtocol

farms = Defi.get_all_farms(DefiProtocol.VVS)
print(farms)

Returns
```
List of all farms for the project.
```

Example Return

{'status': 'Success', 'data': [{'id': exmaple-id, 'pid': exmaple-pid, 'lpSymbol': 'exmaple-lp-symbol', 'lpAddress': 'exmaple-lp-address', 'token': {'id': exmaple-id, 'symbol': 'exmaple-symbol', 'address': 'exmaple-address'}, 'quoteToken': {'id': exmaple-id, 'symbol': 'exmaple-symbol', 'address': 'exmaple-address'}, 'version': 'exmaple-version', 'suffix': 'exmaple-suffix', 'rewardStartAt': 'exmaple-start-time', 'rewardEndAt': 'exmaple-end-time', 'isFinished': exmaple-boolean, 'isMigrated': exmaple-boolean, 'isBoostEnable': exmaple-boolean, 'isBoostFarmExpired': exmaple-boolean, 'isAutoHarvestEnabled': exmaple-boolean, 'rewarders': [{'address': 'exmaple-address', 'token': {'id': exmaple-id, 'symbol': 'exmaple-symbol', 'address': 'exmaple-addrss'}, 'isFinished': exmaple-boolean}], 'chain': 'exmaple-chain-name', 'chainId': exmaple-chain-id, 'baseApr': exmaple-base-apr, 'baseApy': exmaple-base-apy, 'lpApr': exmaple-lp-apr, 'lpApy': exmaple-lp-apy}, ... ]}

Function Name

getAllFarms

Arguments

{DefiProtocol} protocol: The DeFi protocol to fetch farms for.

Example Code

import { Defi, DefiProtocol } from '@crypto.com/developer-platform-client';

try {
  const farms = await Defi.getAllFarms(DefiProtocol.VVS);
  console.log(farms);
}
  catch(err) {
  console.log(err);
}

Returns

{Promise<ApiResponse<Farm[]>>}: A promise that resolves to the farms.

Errors

{Error}: Throws an error if the request fails.

Example Return

{
  status: 'Success',
  data: [
    {
      id: example-id,
      pid: example-pid,
      lpSymbol: example-symbol,
      lpAddress: example-address,
      token: example-token,
      quoteToken: example-token,
      version: example-version,
      suffix: example-suffix,
      rewardStartAt: example-start-time,
      rewardEndAt: example-end-time,
      isFinished: example-boolean,
      isMigrated: example-boolean,
      isBoostEnable: example-boolean,
      isBoostFarmExpired: example-boolean,
      isAutoHarvestEnabled: example-boolean,
      rewarders: example-array,
      chain: example-chain-name,
      chainId: example-chain-id,
      baseApr: example-base-apr,
      baseApy: example-base-apy,
      lpApr: example-lp-apr,
      lpApy: example-lp-apy
    }
    ...
  ]
}

7.3 Get Farm By Symbol

Fetches a specific farm by its symbol for a DeFi protocol.

Function Name

get_farm_by_symbol

Arguments

protocol (DefiProtocol): The DeFi protocol (e.g., DefiProtocol.H2, DefiProtocol.VVS)
symbol (str): The farm symbol (e.g., 'zkCRO-MOON', 'CRO-GOLD')

Example Code

from crypto_com_developer_platform_client import Defi, DefiProtocol

farm = Defi.get_farm_by_symbol(DefiProtocol.H2, 'zkCRO-MOON')
print(farm)

Returns
```
Information about the specific farm
```

Example Return

{'status': 'Success', 'data': {'id': example-id, 'pid': example-pid, 'lpSymbol': 'example-lp-symbol', 'lpAddress': 'example-lp-address', 'token': {'id': example-id, 'symbol': 'example-symbol', 'address': 'example-address'}, 'quoteToken': {'id': example-id, 'symbol': 'example-symbol', 'address': 'example-address'}, 'version': 'example-version', 'suffix': 'example-suffix', 'rewardStartAt': 'example-start-time', 'rewardEndAt': 'example-end-time', 'isFinished': example-boolean, 'isMigrated': example-boolean, 'isBoostEnable': example-boolean, 'isBoostFarmExpired': example-boolean, 'isAutoHarvestEnabled': example-boolean, 'rewarders': [{'address': 'example-address', 'token': {'id': example-id, 'symbol': 'example-symbol', 'address': 'example-address'}, 'isFinished': example-boolean}], 'chain': 'example-chain-name', 'chainId': example-chain-id, 'baseApr': example-baser-apr, 'baseApy': example-base-apy, 'lpApr': example-lp-apr, 'lpApy': example-lp-apy, 'rewarderAprs': [{'address': 'example-address', 'tokenAddress': 'example-addrss', 'tokenSymbol': 'example-symbol', 'apr': example-apr, 'apy': example-apy}]}}

Function Name

getFarmBySymbol

Arguments

{DefiProtocol} protocol: The DeFi protocol to fetch the farm from.
{string} symbol: The symbol of the farm to fetch.

Example Code

import { Defi, DefiProtocol } from '@crypto.com/developer-platform-client';

try {
  const farm = await Defi.getFarmBySymbol(DefiProtocol.H2, 'zkCRO-MOON');
  console.log(farm);
}
  catch(err) {
  console.log(err);
}

Returns

{Promise<ApiResponse<Farm>>} - A promise that resolves to the farm details.

Errors

{Error}: Throws an error if the request fails.

Example Return

{
  status: 'Success',
  data: {
    id: example-id,
    pid: example-pid,
    lpSymbol: example-lp-symbol,
    lpAddress: example-lp-address,
    token: {
      id: example-id,
      symbol: example-symbol,
      address: example-address
    },
    quoteToken: {
      id: example-id,
      symbol: example-symbol,
      address: example-address
    },
    version: example-version,
    suffix: example-suffix,
    rewardStartAt: example-start-time,
    rewardEndAt: example-end-time,
    isFinished: example-boolean,
    isMigrated: example-boolean,
    isBoostEnable: example-boolean,
    isBoostFarmExpired: example-boolean,
    isAutoHarvestEnabled: example-boolean,
    rewarders: example-array,
    chain: example-chain-name,
    chainId: example-chain-id,
    baseApr: example-base-apr,
    baseApy: example-base-apy,
    lpApr: example-lp-apr,
    lpApy: example-lp-apy,
    rewarderAprs: example-array
  }
}

PreviousCronosID Module NextExchange Module

Last updated 1 year ago

Was this helpful?