getContract | Circle

SDK Explorer

Developer Controlled Wallets

Getting Started

Methods Overview

Developer Account

Initialization

Transactions

Monitored Tokens

Webhook Subscriptions

Wallets

Wallet Sets

Token Lookup

Faucet

Signing

getContractNode.js,latest

Go to NPM

Retrieves a single contract that you've imported or deployed. You need to provide the contract's ID instead of the on-chain address.

Parameters

input

object

Required

Represents the input for fetching a contract.

Show 1 properties

string

Required

The contract's ID.

Responses

ContractResponse

Response Body

object

data

object

Required

Show 1 properties

contract

object

Required

Show 25 properties

abiJson

string

The contract's ABI in a JSON stringified format.

archived

boolean

Required

The archive state of the contract. If true, the contract will not be visible in your dashboard.

blockchain

string

Required

The blockchain network that the resource is to be created on or is currently on. Required along with sourceAddress if you don't provide walletId. The blockchain and walletId fields are mutually exclusive.

Allowed valuesARBARB-SEPOLIABASEBASE-SEPOLIAETHETH-SEPOLIAMATICMATIC-AMOYOPOP-SEPOLIAUNIUNI-SEPOLIA

bytecode

string

Bytecode of the contract being deployed.

contractAddress

string

The on-chain address of this contract.

contractInputType

string

Required

The input type for the contract.

Allowed valuesAUTO_IMPORTBYTECODEIMPORTTEMPLATE

createDate

string

Required

Date and time the resource was created, in ISO-8601 UTC format.

deployerAddress

string

The address that created this contract, if deployed.

deployerUserID

string

deployerWalletID

string

The id of the Programmable Wallet that deployed this contract.

deploymentErrorDetails

string

deploymentErrorReason

string

deploymentTransactionId

string

The id of the deployment transaction for this contract.

description

string

The description for a contract.

events

array of objects

Required

Events this contract can emit. Parsed from abi_json.

Show 4 properties

anonymous

boolean

inputs

array of objects

Show 5 properties

components

array of anys

flattenedType

string

indexed

boolean

name

string

type

string

name

string

type

string

Required

functions

array of objects

Required

Functions supported by this contract. Parsed from abi_json.

Show 5 properties

inputs

array of objects

Show 5 properties

components

array of anys

flattenedType

string

indexed

boolean

name

string

type

string

name

string

outputs

array of objects

Show 5 properties

components

array of anys

flattenedType

string

indexed

boolean

name

string

type

string

stateMutability

string

type

string

Required

string

Required

System-generated unique identifier of the resource.

implementationContract

object

Object of the implementation contract.

metadataLink

string

The ipfs metadata link of the contract.

name

string

Required

The name for a contract. Must be alphanumeric [a-zA-Z0-9].

sourceCode

array of objects

Required

Show 2 properties

fileContent

string

Required

Content of the file. If the contract's source code was flattened before verification, this may be the entire source code.

fileName

string

Name of the file.

status

string

Required

The status of the contract.

Allowed valuesCOMPLETEFAILEDPENDING

txHash

string

Blockchain generated identifier of the transaction.

updateDate

string

Required

Date and time the resource was last updated, in ISO-8601 UTC format.

verificationStatus

string

Required

The verification status of the contract.

Allowed valuesUNVERIFIEDVERIFIED

Example

1const response = await client.getContract({
2  id: '39c7146d-d240-45c3-9402-8d817a633b17',
3})
4console.log(response.data)

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy