Skip to main content

Radius plugin for ERC20

Project description

Radius AI Agent Toolkit - ERC20 Plugin

This plugin enables AI agents to interact with ERC20 tokens on Radius, allowing them to check balances, transfer tokens, and manage token approvals.

This package is part of the Radius AI Agent Toolkit, which provides tools for integrating AI agents with the Radius platform.

Installation

# Install this specific package
pip install radius-ai-agent-sdk-plugin-erc20

# Required dependencies
pip install radius-ai-agent-sdk
pip install radius-ai-agent-sdk-wallet-evm

Prerequisites

  • Python >=3.10
  • Radius wallet setup with a funded account

Usage

from radius_plugins.erc20 import erc20, USDC
from radius_wallets.evm import create_evm_wallet
from radius_adapters.langchain import get_on_chain_tools

# Create a Radius wallet
wallet = create_evm_wallet({
    "rpc_url": "https://testnet.radius.xyz/rpc",
    "private_key": "0x123..." # Your private key
})

# Initialize the ERC20 plugin with predefined tokens
erc20_plugin = erc20({
    "tokens": [USDC]
})

# Create AI agent tools with the ERC20 plugin
tools = get_on_chain_tools({
    "wallet_client": wallet,
    "plugins": [erc20_plugin]
})

Adding Custom Tokens

You can add your own custom tokens by defining their details:

from radius_plugins.erc20 import erc20, USDC, Token

# Create an ERC20 plugin with both predefined and custom tokens
erc20_plugin = erc20({
    "tokens": [
        USDC,  # Predefined token
        {
            # Custom token definition
            "decimals": 18,
            "symbol": "RADUSD",
            "name": "Radius Token",
            "chains": {
                1223953: {  # Radius testnet chain ID
                    "contractAddress": "0x9aeEa4f3025940dBdbf6863C7e16a23Ea95272a4"
                }
            }
        }
    ]
})

API Reference

erc20(options)

Creates a new ERC20 plugin instance.

Parameters:

  • options.tokens (List[Token]): Array of token definitions to enable

Returns:

  • An ERC20Plugin instance that can be used with AI agent frameworks

Predefined Tokens

The package includes these predefined tokens:

  • USDC: USD Coin stablecoin

Provided Tools

The ERC20 plugin provides the following AI agent tools:

get_token_info_by_symbol

Gets information about a token by its symbol.

Parameters:

  • symbol (str): The token symbol to lookup

Example:

try:
    token_info = await get_token_info_by_symbol_tool.execute({
        "symbol": "USDC"
    })
    print("Token info:", token_info)
    # { "symbol": "USDC", "name": "USD Coin", "decimals": 6, "contractAddress": "0x..." }
except Exception as error:
    print(f"Token info lookup failed: {error}")

get_token_balance

Gets the balance of a specific token for an address.

Parameters:

  • tokenAddress (str): The token contract address
  • wallet (str): The wallet address to check

Example:

try:
    balance = await get_token_balance_tool.execute({
        "tokenAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",  # USDC
        "wallet": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
    })
    print(f"Balance: {balance}")
except Exception as error:
    print(f"Balance check failed: {error}")

transfer

Transfers tokens from the wallet to another address.

Parameters:

  • tokenAddress (str): The token contract address
  • to (str): The recipient address
  • amount (str): The amount to transfer in base units

get_token_total_supply

Gets the total supply of a token.

Parameters:

  • tokenAddress (str): The token contract address

get_token_allowance

Gets the current allowance for a spender.

Parameters:

  • tokenAddress (str): The token contract address
  • owner (str): The token owner
  • spender (str): The spender address

approve

Approves a spender to use a specific amount of tokens.

Parameters:

  • tokenAddress (str): The token contract address
  • spender (str): The spender address
  • amount (str): The amount to approve in base units

transfer_from

Transfers tokens from one address to another using the connected wallet as the spender.

Parameters:

  • tokenAddress (str): The token contract address
  • from (str): The address to transfer from
  • to (str): The recipient address
  • amount (str): The amount to transfer in base units

convert_to_base_unit

Converts a human-readable token amount to its base unit.

Parameters:

  • amount (float): The decimal amount (e.g., 10.5)
  • decimals (int): The token decimals (e.g., 6 for USDC, 18 for most tokens)

Example:

try:
    base_unit_result = await convert_to_base_unit_tool.execute({
        "amount": 100,
        "decimals": 6  # USDC has 6 decimals
    })
    print(f"100 USDC in base units: {base_unit_result}")  # 100000000
except Exception as error:
    print(f"Conversion failed: {error}")

convert_from_base_unit

Converts a base unit token amount to its human-readable form.

Parameters:

  • amount (float): The amount in base units
  • decimals (int): The token decimals

Example:

try:
    decimal_result = await convert_from_base_unit_tool.execute({
        "amount": 100000000,  # 100 USDC in base units
        "decimals": 6  # USDC has 6 decimals
    })
    print(f"100000000 base units in USDC: {decimal_result}")  # 100.0
except Exception as error:
    print(f"Conversion failed: {error}")

Note on Tool Naming: The tool names in this documentation match the actual names used at runtime. The @Tool decorator in the implementation automatically converts camelCase method names to snake_case for the final tool names.

Integration Examples

For examples integrating this plugin with the LangChain framework, see:

Related Packages

Resources

Contributing

Please see the Contributing Guide for detailed information about contributing to this toolkit.

License

This project is licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

radius_ai_agent_sdk_plugin_erc20-1.0.0.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file radius_ai_agent_sdk_plugin_erc20-1.0.0.tar.gz.

File metadata

File hashes

Hashes for radius_ai_agent_sdk_plugin_erc20-1.0.0.tar.gz
Algorithm Hash digest
SHA256 a54ac0563b36e954ed35c4f57cc1b9663a592ae37641ff7e3ebaa5c39d9f8794
MD5 bdf993775a6235c5ee241a6433bd2eab
BLAKE2b-256 96309682e724854821449982270c92da1dbf637945b57fedada47bfb6bce996f

See more details on using hashes here.

File details

Details for the file radius_ai_agent_sdk_plugin_erc20-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for radius_ai_agent_sdk_plugin_erc20-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e8640cba32e1a50c7cfd5afdf42ca6f5dca63176158485f0dc562c0a885d3104
MD5 dea9909636cbd5da2c7fe6a02d3695b5
BLAKE2b-256 9373569d8e22bf782b6559c33cadee3c06e47fb465d6cc7065fdbb1ec8d5fd4d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page