Smart Contract Interaction

List Deployed Smart Contracts

List Deployed Smart Contracts

**Note: This API only return smart contract(s) deployed through your organisation API key

GET

API_URL/api/contract/smart-contracts

HEADERS

client_id   9b16ae5638534ae1961fb370f874b6cc*

client_secret   sk_9b16ae5638534ae1961fb370f874b6cc*

The returned values will be in the format of

Sample Result

{
    "result": [
        {
            "contract_address": "0x8dAaE2E5bf2AC0833B2287864A15Fa860B98EbDd",
            "deployment_params": [],
            "contract_name": "ContractA",
            "project_name": "Test Project",
            "version": "v1.0.0",
            "deployed_at": "2024-12-05T07:12:42.000000Z"
        },
        ...
    ],
    "pagination": {
        "current_page": 1,
        "first_page_url": "http://localhost/api/smart-contracts?page=1",
        "last_page": 1,
        "last_page_url": "http://localhost/api/smart-contracts?page=1",
        "next_page_url": null,
        "per_page": 10,
        "prev_page_url": null,
        "total": 4
    },
    "message": "Success"
}

Get Contract Details By Address

Get Contract Details By Address

GET

API_URL/api/contract/smart-contracts/{address}

HEADERS

client_id   9b16ae5638534ae1961fb370f874b6cc*

client_secret   sk_9b16ae5638534ae1961fb370f874b6cc*

The returned values will be in the format of

Sample Result

{
    "message": "Success",
    "result": {
        "contract_address": "0x8dAaE2E5bf2AC0833B2287864A15Fa860B98EbDd",
        "deployment_params": [],
        "artifact": {
            "id": 18,
            "contract_name": "ContractA",
            "contract_abi": [
                {
                    "name": "CountIncreased",
                    "type": "event",
                    "inputs": [
                        {
                            "name": "_count",
                            "type": "uint256",
                            "indexed": false,
                            "internalType": "uint256"
                        }
                    ],
                    "anonymous": false
                },
                {
                    "name": "count",
                    "type": "function",
                    "inputs": [],
                    "outputs": [
                        {
                            "name": "",
                            "type": "uint256",
                            "internalType": "uint256"
                        }
                    ],
                    "stateMutability": "view"
                },
                {
                    "name": "increment",
                    "type": "function",
                    "inputs": [],
                    "outputs": [],
                    "stateMutability": "nonpayable"
                }
            ],
            "bytecode": "0x60806040526000...",
            "source_code": "fileUrl",
            "created_at": "2024-12-05T06:55:50.000000Z",
            "updated_at": "2024-12-05T06:55:50.000000Z"
        },
        "deployed_at": "2024-12-05T07:12:42.000000Z",
        "deployment_id": "test-project_1-v100_1733382752",
        "deploy_gas_used": 144321,
        "total_gas_used": 310275
    }
}

Smart Contract Call (Read)

Smart Contract Call (Read)

POST

API_URL/api/contract/smart-contracts/{address}/call

HEADERS

client_id   9b16ae5638534ae1961fb370f874b6cc*

client_secret   sk_9b16ae5638534ae1961fb370f874b6cc*

Params

Name	Required	Description
from	Yes	The address to call the smart contract from
method_name	Yes	The method name to call
params	Required if method requires parameter	Key-value array list of parameters required for the method call

Sample Request Body

{
    "from": "0xC7F59f4F9E...Cabb9F9Cf5c48ac6",
    "method_name": "methodName",
    "params": {
        "fieldA": "...",
        ...
    }
}

The returned values will be in the format of

Sample Result

{
    "message": "Success",
    "result": {
        "_count": "0",
        "_count2": "0"
    }
}

Smart Contract Execute (Write)

Smart Contract Execute (Write)

POST

API_URL/api/contract/smart-contracts/{address}/execute

HEADERS

client_id   9b16ae5638534ae1961fb370f874b6cc*

client_secret   sk_9b16ae5638534ae1961fb370f874b6cc*

Example using custodial wallet

Params

Name	Required	Description
wallet_options.type	Yes	Wallet type to be used for contract execution. Accepted values: organisation, end_user
wallet_options.address	Yes	Wallet address to be used for contract execution
method_name	Yes	The method name of the function to execute
params	Required if method requires parameter	Key-value array list of parameters required for the method execution

Sample Request Body (Custodial Wallet)

{
    "wallet_options": {
        "type": "organisation",
        "address": "0xC7F59f4F9E9e490023576E33Cabb9F9Cf5c48ac6"
    },
    "method_name": "increment",
    "params": {
        "fieldA": "...",
        ...
    }
}

The returned values will be in the format of

Sample Result (Custodial Wallet)

{
    "message": "Success",
    "result": {
        "requestId": 4003,
        "nonce": 50,
        "status": 2,
        "receipt": {
            "transactionHash": "0xb2a906eeddd6ec1e1ba3c8a9337bcfb35c48583abcf9c6be128546953d94f4ca",
            "transactionIndex": 0,
            "blockHash": "0x67358a6822992c126719ffee1ef2963ad03d5f2b19774a10030fcf3937df3df0",
            "from": "0xc7f59f4f9e9e490023576e33cabb9f9cf5c48ac6",
            "to": "0x22e726f2d2049bd6b7af65115590c157450f738c",
            "blockNumber": 5679452,
            "gasUsed": 27659,
            "contractAddress": null,
            "logs": [
                {
                    "address": "0x22E726F2d2049BD6b7af65115590C157450F738c",
                    "topics": [
                        "0x7ca2ca9527391044455246730762df008a6b47bbdb5d37a890ef78394535c040"
                    ],
                    "data": "0x0000000000000000000000000000000000000000000000000000000000000010",
                    "blockHash": "0x67358a6822992c126719ffee1ef2963ad03d5f2b19774a10030fcf3937df3df0",
                    "blockNumber": 5679452,
                    "transactionHash": "0xb2a906eeddd6ec1e1ba3c8a9337bcfb35c48583abcf9c6be128546953d94f4ca",
                    "transactionIndex": 0,
                    "logIndex": 0,
                    "transactionLogIndex": "0x0",
                    "removed": false,
                    "id": "log_19a73487"
                }
            ],
            "logsBloom": "0x000000000000...",
            "status": true,
            "type": "0x0"
        }
    }
}

Example using non-custodial wallet

Params

Name	Required	Description
wallet_options.type	Yes	Wallet type to be used to for contract execution. Accepted values: non_custodial
wallet_options.address	Yes	Wallet address to be used for contract execution
method_name	Yes	The method name of the function to execute
signed_trx	Yes	The self-signed transaction for the contract execution

Sample Request Body (Non-custodial Wallet)

{
    "wallet_options": {
        "type": "non_custodial",
        "address": "0x6BCEB78D049FFE517b060fbD6DC1eA11b8e3f4f7"
    },
    "method_name": "increment",
    "signed_trx": "0xf866048083..."
}

The returned values will be in the format of

Sample Result (Non-custodial Wallet)

{
    "message": "Success",
    "result": {
        "requestId": 4002,
        "transactionHash": "0xbf3ee3ccc6fa9dbac294cee461f9b5803479b3f54338711ef031899de6526704",
        "from": "0x6BCEB78D049FFE517b060fbD6DC1eA11b8e3f4f7",
        "status": 2,
        "receipt": {
            "transactionHash": "0xbf3ee3ccc6fa9dbac294cee461f9b5803479b3f54338711ef031899de6526704",
            "transactionIndex": 0,
            "blockHash": "0xda22cab1111bb5008dc25c7eda5ab9e557e35fe76ee073042b118a3f9f73f1b5",
            "from": "0x6bceb78d049ffe517b060fbd6dc1ea11b8e3f4f7",
            "to": "0x8daae2e5bf2ac0833b2287864a15fa860b98ebdd",
            "blockNumber": 5581339,
            "gasUsed": 27659,
            "contractAddress": null,
            "logs": [
                {
                    "address": "0x8dAaE2E5bf2AC0833B2287864A15Fa860B98EbDd",
                    "topics": [
                        "0x7ca2ca9527391044455246730762df008a6b47bbdb5d37a890ef78394535c040"
                    ],
                    "data": "0x0000000000000000000000000000000000000000000000000000000000000008",
                    "blockHash": "0xda22cab1111bb5008dc25c7eda5ab9e557e35fe76ee073042b118a3f9f73f1b5",
                    "blockNumber": 5581339,
                    "transactionHash": "0xbf3ee3ccc6fa9dbac294cee461f9b5803479b3f54338711ef031899de6526704",
                    "transactionIndex": 0,
                    "logIndex": 0,
                    "transactionLogIndex": "0x0",
                    "removed": false,
                    "id": "log_c521d40c"
                }
            ],
            "logsBloom": "0x000000000000...",
            "status": true,
            "type": "0x0"
        }
    }
}