Create smart contract interface

Create an ABI/IDL in JSON.

POST

/

public

/

v1

/

submit

/

create_smart_contract_interface

Authorizations

API Key

X-Stamp · string · required

Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.

WebAuthn (Passkey)

X-Stamp-WebAuthn · string · required

Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_CREATE_SMART_CONTRACT_INTERFACE

timestampMs · string · required

Timestamp (in milliseconds) of the request, used to verify liveness of user requests.

organizationId · string · required

Unique identifier for a given Organization.

parameters · object · required

The parameters object containing the specific intent data for this activity.

Show details

parameters.smartContractAddress

string

required

Corresponding contract address or program ID

parameters.smartContractInterface

string

required

ABI/IDL as a JSON string. Limited to 400kb

parameters.type

enum<string>

required

Enum options: SMART_CONTRACT_INTERFACE_TYPE_ETHEREUM, SMART_CONTRACT_INTERFACE_TYPE_SOLANA

parameters.label

string

required

Human-readable name for a Smart Contract Interface.

parameters.notes

string

Notes for a Smart Contract Interface.

generateAppProofs · boolean

Enable to have your activity generate and return App Proofs, enabling verifiability.

Response

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

activity.id

string

required

Unique identifier for a given Activity object.

activity.organizationId

string

required

Unique identifier for a given Organization.

activity.status

string

required

The activity status

activity.type

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.createSmartContractInterfaceIntent

object

required

The createSmartContractInterfaceIntent object

Show createSmartContractInterfaceIntent details

activity.intent.createSmartContractInterfaceIntent.smartContractAddress

string

required

Corresponding contract address or program ID

activity.intent.createSmartContractInterfaceIntent.smartContractInterface

string

required

ABI/IDL as a JSON string. Limited to 400kb

activity.intent.createSmartContractInterfaceIntent.type

enum

required

type field

Enum options: SMART_CONTRACT_INTERFACE_TYPE_ETHEREUM, SMART_CONTRACT_INTERFACE_TYPE_SOLANA

activity.intent.createSmartContractInterfaceIntent.label

string

required

Human-readable name for a Smart Contract Interface.

activity.intent.createSmartContractInterfaceIntent.notes

string

Notes for a Smart Contract Interface.

activity.result

object

required

The result of the activity

Show result details

activity.result.createSmartContractInterfaceResult

object

required

The createSmartContractInterfaceResult object

Show createSmartContractInterfaceResult details

activity.result.createSmartContractInterfaceResult.smartContractInterfaceId

string

required

The ID of the created Smart Contract Interface.

activity.votes

array

required

A list of objects representing a particular User’s approval or rejection of a Consensus request, including all relevant metadata.

activity.fingerprint

string

required

An artifact verifying a User’s action.

activity.canApprove

boolean

required

Whether the activity can be approved.

activity.canReject

boolean

required

Whether the activity can be rejected.

activity.createdAt

string

required

The creation timestamp.

activity.updatedAt

string

required

The last update timestamp.

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/create_smart_contract_interface \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_SMART_CONTRACT_INTERFACE",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "smartContractAddress": "<string>",
        "smartContractInterface": "<string>",
        "type": "<SMART_CONTRACT_INTERFACE_TYPE_ETHEREUM>",
        "label": "<string>",
        "notes": "<string>"
    }
}'

import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().createSmartContractInterface({
  smartContractAddress: "<string> (Corresponding contract address or program ID)",
  smartContractInterface: "<string> (ABI/IDL as a JSON string. Limited to 400kb)",
  type: "<SMART_CONTRACT_INTERFACE_TYPE_ETHEREUM>" // type field,
  label: "<string> (Human-readable name for a Smart Contract Interface.)",
  notes: "<string> (Notes for a Smart Contract Interface.)"
});

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_CREATE_SMART_CONTRACT_INTERFACE",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "createSmartContractInterfaceIntent": {
            "smartContractAddress": "<string>",
            "smartContractInterface": "<string>",
            "type": "<SMART_CONTRACT_INTERFACE_TYPE_ETHEREUM>",
            "label": "<string>",
            "notes": "<string>"
          }
        },
        "result": {
          "createSmartContractInterfaceResult": {
            "smartContractInterfaceId": "<string>"
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}