1 of 5

Contract

The Contract entity offers a normalized representation of the Casper Network Contract without including entry point hashes, which can be queried separately using the Contract entry point API. Additionally, this entity omits the contract's named keys but utilizes them for identifying the contract's type.

Properties

The Contract entity has the following properties:

Property

Type

Description

contract_hash

string(64)

Contract hash represented as a hexadecimal string. Unique contract identifier

contract_package_hash

string(64)

Hash of the contract package, this contract version is a part of, represented as a hexadecimal string

block_height

uint64

Height of the block in which the contract was deployed to the network

deploy_hash

string(64)

Hash of the deploy that deployed the contract to the network represented as a hexadecimal string

contract_type_id

uint8

timestamp

uint16

Timestamp indicating when the contract was created

contract_version

uint16

Version number associated with the contract

is_disabled

bool

Indicates whether the contract is currently disabled

timestamp

datetime

Timestamp indicating when the contract was created

contract_version

uint16

Version number associated with the contract

is_disabled

bool

Indicates whether the contract is currently disabled

Example

{
  "contract_hash": "8a2feaa4e86841c1c6f40f1779e1e1cb1d9d4d52a0eb82a8962829646524e732",
  "contract_package_hash": "ae2feaa4e86841c1c6f40f1779e1e1cb1d9d4d52a0eb82a8962829646524e744",
  "deploy_hash": "1a2feaa4e86841c1c6f40f1779e1e1cb1d9d4d52a0eb82a8962829646524e755",
  "block_height": 2764649,
  "contract_type_id": 2,
  "timestamp": "2023-01-01T12:00:00Z",
  "contract_version": 1,
  "is_disabled": false
}

Optional properties

Depending on the endpoint, the following optional properties may be included in the Contract entity:

Property

Type

Description

contract_package

Contract package, this contract version is a part of

Relations

The Contract entity has the following relations with other entities:

Entity

Mapping property

Description

contract_hash, deploy_hash

Contracts are deployed to the network with a deploy call. Deploys can be the contract call

contract_hash

Contracts can have endpoints

contract_package_hash

Contracts are different versions of the same smart contract under the contract package

Endpoints

The Contract entity has the following endpoints:

Get contract
Get contracts
Get contract package contracts

Relation endpoints

The Contract entity has the following relation endpoints:

Get contract

Get contract by its hash.

GET /contracts/{contract_hash}

Query params

None

Sorting

None

Optional properties

Property

Type

Description

contract_package

Contract package, this contract version is a part of

Response

Contract

Example

curl -X 'GET' \
  'https://api.testnet.cspr.cloud/contracts/8a2feaa4e86841c1c6f40f1779e1e1cb1d9d4d52a0eb82a8962829646524e732' \
  -H 'Accept: application/json' \
  -H 'Authorization: 55f79117-fc4d-4d60-9956-65423f39a06a'

{
  "data": {
    "contract_hash": "8a2feaa4e86841c1c6f40f1779e1e1cb1d9d4d52a0eb82a8962829646524e732",
    "contract_package_hash": "ae2feaa4e86841c1c6f40f1779e1e1cb1d9d4d52a0eb82a8962829646524e744",
    "deploy_hash": "1a2feaa4e86841c1c6f40f1779e1e1cb1d9d4d52a0eb82a8962829646524e755",
    "block_height": 2404577,
    "contract_type_id": 2,
    "timestamp": "2023-01-01T12:00:00Z",
    "contract_version": 1,
    "is_disabled": false
  }
}

Get contracts

Get a paginated list of contracts.

Query params

Query param

Description

Sorting

Property

Description

Default sorting is timestamp DESC

Optional properties

Property

Type

Description

Response

Example

Get contracts by contract package

Retrieve contracts associated with a specific contract package.

GET /contract-packages/{contract_package_hash}/contracts

This endpoint allows you to retrieve contracts associated with a specific contract package. You can filter the results by deploy hash and choose to include optional fields such as contract package data. The example demonstrates a sample response with details for each contract, including contract hash, contract package hash, deploy hash, contract type ID, timestamp, contract version, and disabled status.

Query params

Query param

Description

deploy_hash

Hash of the deploy that deployed the contract to the network

Sorting

None

Optional properties

Property

Type

Description

contract_package

Contract package, this contract version is a part of

Sorting

Property

Description

timestamp

Sort contracts by timestamp

Default sorting is timestamp DESC

Response

PaginatedResponse<Contract>

Example

curl -X 'GET' \
  'https://api.testnet.cspr.cloud/contract-packages/ae2feaa4e86841c1c6f40f1779e1e1cb1d9d4d52a0eb82a8962829646524e744/contracts' \
  -H 'Accept: application/json' \
  -H 'Authorization: 55f79117-fc4d-4d60-9956-65423f39a06a'

{
  "data": [
    {
      "contract_hash": "8a2feaa4e86841c1c6f40f1779e1e1cb1d9d4d52a0eb82a8962829646524e732",
      "contract_package_hash": "ae2feaa4e86841c1c6f40f1779e1e1cb1d9d4d52a0eb82a8962829646524e744",
      "deploy_hash": "1a2feaa4e86841c1c6f40f1779e1e1cb1d9d4d52a0eb82a8962829646524e755",
      "contract_type_id": 2,
      "timestamp": "2023-01-01T12:00:00Z",
      "contract_version": 1,
      "is_disabled": false
    },
    {
      "contract_hash": "5e718fa0918ae95e58b9a320f412b935af6544b04b6b89fb2ca9982cab0dd261",
      "contract_package_hash": "8e718fa0918ae95e58b9a320f412b935af6544b04b6b89fb2ca9982cab0dd262",
      "deploy_hash": "2e718fa0918ae95e58b9a320f412b935af6544b04b6b89fb2ca9982cab0dd263",
      "contract_type_id": 4,
      "timestamp": "2023-01-02T12:00:00Z",
      "contract_version": 2,
      "is_disabled": false
    },
    ...
  ],
  "item_count": 100,
  "page_count": 10
}

Get contract types

Get all contract types with their id and name.

GET /contract-types

Query params

None

Sorting

None

Optional properties

None

Response

List of value objects describing the available contract types

Example

curl -X 'GET' \
  'https://api.testnet.cspr.cloud/contract-types' \
  -H 'Accept: application/json' \
  -H 'Authorization: 55f79117-fc4d-4d60-9956-65423f39a06a'

{
  "data": [
    {
      "id": 2,
      "name": "CEP18"
    },
    {
      "id": 3,
      "name": "Modified CEP18"
    },
    {
      "id": 4,
      "name": "CEP47"
    },
    {
      "id": 5,
      "name": "Modified CEP47"
    },
    {
      "id": 6,
      "name": "DEFI"
    },
    {
      "id": 7,
      "name": "CEP78"
    },
    {
      "id": 8,
      "name": "Modified CEP78"
    },
    {
      "id": 9,
      "name": "NFT"
    }
  ]
}

Contract

Properties

The Contract entity has the following properties:

Property

Type

Description

contract_hash

string(64)

Contract hash represented as a hexadecimal string. Unique contract identifier

contract_package_hash

string(64)

Hash of the contract package, this contract version is a part of, represented as a hexadecimal string

block_height

uint64

Height of the block in which the contract was deployed to the network

deploy_hash

string(64)

Hash of the deploy that deployed the contract to the network represented as a hexadecimal string

contract_type_id

uint8

Identifier representing the type of the contract, check the types list

timestamp

uint16

Timestamp indicating when the contract was created

contract_version

uint16

Version number associated with the contract

is_disabled

bool

Indicates whether the contract is currently disabled

timestamp

datetime

Timestamp indicating when the contract was created

contract_version

uint16

Version number associated with the contract

is_disabled

bool

Indicates whether the contract is currently disabled

Example

{
  "contract_hash": "8a2feaa4e86841c1c6f40f1779e1e1cb1d9d4d52a0eb82a8962829646524e732",
  "contract_package_hash": "ae2feaa4e86841c1c6f40f1779e1e1cb1d9d4d52a0eb82a8962829646524e744",
  "deploy_hash": "1a2feaa4e86841c1c6f40f1779e1e1cb1d9d4d52a0eb82a8962829646524e755",
  "block_height": 2764649,
  "contract_type_id": 2,
  "timestamp": "2023-01-01T12:00:00Z",
  "contract_version": 1,
  "is_disabled": false
}

Optional properties

Depending on the endpoint, the following optional properties may be included in the Contract entity:

Property

Type

Description

contract_package

Contract package, this contract version is a part of

Relations

The Contract entity has the following relations with other entities:

Entity

Mapping property

Description

contract_hash, deploy_hash

Contracts are deployed to the network with a deploy call. Deploys can be the contract call

contract_hash

Contracts can have endpoints

contract_package_hash

Contracts are different versions of the same smart contract under the contract package

Endpoints

The Contract entity has the following endpoints:

Get contract
Get contracts
Get contract package contracts

Relation endpoints

The Contract entity has the following relation endpoints:

Get contracts by contract package

Retrieve contracts associated with a specific contract package.

GET /contract-packages/{contract_package_hash}/contracts

Query params

Query param

Description

deploy_hash

Hash of the deploy that deployed the contract to the network

Sorting

None

Optional properties

Property

Type

Description

contract_package

Contract package, this contract version is a part of

Sorting

Property

Description

timestamp

Sort contracts by timestamp

Default sorting is timestamp DESC

Response

PaginatedResponse<Contract>

Example

curl -X 'GET' \
  'https://api.testnet.cspr.cloud/contract-packages/ae2feaa4e86841c1c6f40f1779e1e1cb1d9d4d52a0eb82a8962829646524e744/contracts' \
  -H 'Accept: application/json' \
  -H 'Authorization: 55f79117-fc4d-4d60-9956-65423f39a06a'

{
  "data": [
    {
      "contract_hash": "8a2feaa4e86841c1c6f40f1779e1e1cb1d9d4d52a0eb82a8962829646524e732",
      "contract_package_hash": "ae2feaa4e86841c1c6f40f1779e1e1cb1d9d4d52a0eb82a8962829646524e744",
      "deploy_hash": "1a2feaa4e86841c1c6f40f1779e1e1cb1d9d4d52a0eb82a8962829646524e755",
      "contract_type_id": 2,
      "timestamp": "2023-01-01T12:00:00Z",
      "contract_version": 1,
      "is_disabled": false
    },
    {
      "contract_hash": "5e718fa0918ae95e58b9a320f412b935af6544b04b6b89fb2ca9982cab0dd261",
      "contract_package_hash": "8e718fa0918ae95e58b9a320f412b935af6544b04b6b89fb2ca9982cab0dd262",
      "deploy_hash": "2e718fa0918ae95e58b9a320f412b935af6544b04b6b89fb2ca9982cab0dd263",
      "contract_type_id": 4,
      "timestamp": "2023-01-02T12:00:00Z",
      "contract_version": 2,
      "is_disabled": false
    },
    ...
  ],
  "item_count": 100,
  "page_count": 10
}