Skip to content

Latest commit

 

History

History
869 lines (638 loc) · 60.3 KB

SmartRollupsApi.md

File metadata and controls

869 lines (638 loc) · 60.3 KB

Bzzhh\Tzkt\SmartRollupsApi

All URIs are relative to https://api.tzkt.io, except if the operation defines another base path.

Method HTTP request Description
smartRollupsGetEntrypoints() GET /v1/smart_rollups/{address}/entrypoints Get smart rollup entrypoints
smartRollupsGetInboxMessages() GET /v1/smart_rollups/inbox Get inbox messages
smartRollupsGetInboxMessagesCount() GET /v1/smart_rollups/inbox/count Get inbox messages count
smartRollupsGetInterface() GET /v1/smart_rollups/{address}/interface Get JSON Schema [2020-12] interface for the smart rollup
smartRollupsGetSmartRollup() GET /v1/smart_rollups/{address} Get smart rollup by address
smartRollupsGetSmartRollupCommitments() GET /v1/smart_rollups/commitments Get smart rollup commitments
smartRollupsGetSmartRollupCommitmentsCount() GET /v1/smart_rollups/commitments/count Get smart rollup commitments count
smartRollupsGetSmartRollupGames() GET /v1/smart_rollups/games Get smart rollup games
smartRollupsGetSmartRollupGamesCount() GET /v1/smart_rollups/games/count Get smart rollup games count
smartRollupsGetSmartRollupStakers() GET /v1/smart_rollups/{address}/stakers Get smart rollup stakers
smartRollupsGetSmartRollups() GET /v1/smart_rollups Get smart rollups
smartRollupsGetSmartRollupsCount() GET /v1/smart_rollups/count Get smart rollups count

smartRollupsGetEntrypoints()

smartRollupsGetEntrypoints($address, $all, $json, $micheline, $michelson): \Bzzhh\Tzkt\Model\Entrypoint[]

Get smart rollup entrypoints

Returns entrypoints of the specified smart rollup.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\SmartRollupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$address = 'address_example'; // string | Smart rollup address (starting with sr1)
$all = false; // bool | If true, returns all entrypoints, including unused ones.             Unused means that the entrypoint can be normalized to a more specific one.             For example here `(or %entry1 (unit %entry2) (nat %entry3))` the `%entry1` is unused entrypoint             because it can be normalized to `%entry2` or `%entry3`
$json = true; // bool | Include parameters schema in human-readable JSON format
$micheline = false; // bool | Include parameters schema in micheline format
$michelson = false; // bool | Include parameters schema in michelson format

try {
    $result = $apiInstance->smartRollupsGetEntrypoints($address, $all, $json, $micheline, $michelson);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SmartRollupsApi->smartRollupsGetEntrypoints: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
address string Smart rollup address (starting with sr1)
all bool If true, returns all entrypoints, including unused ones. Unused means that the entrypoint can be normalized to a more specific one. For example here `(or %entry1 (unit %entry2) (nat %entry3))` the `%entry1` is unused entrypoint because it can be normalized to `%entry2` or `%entry3` [optional] [default to false]
json bool Include parameters schema in human-readable JSON format [optional] [default to true]
micheline bool Include parameters schema in micheline format [optional] [default to false]
michelson bool Include parameters schema in michelson format [optional] [default to false]

Return type

\Bzzhh\Tzkt\Model\Entrypoint[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

smartRollupsGetInboxMessages()

smartRollupsGetInboxMessages($id, $level, $timestamp, $type, $sort, $offset, $limit, $select, $micheline): \Bzzhh\Tzkt\Model\SrMessage[]

Get inbox messages

Returns a list of smart rollup inbox messages.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\SmartRollupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by internal TzKT id.   Click on the parameter to expand more details.
$level = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by level of the block, where the message was pushed.   Click on the parameter to expand more details.
$timestamp = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysFirstTimeParameter(); // BigMapsGetBigMapKeysFirstTimeParameter | Filter by timestamp of the block, where the message was pushed.   Click on the parameter to expand more details.
$type = new \Bzzhh\Tzkt\Model\SmartRollupsGetInboxMessagesCountTypeParameter(); // SmartRollupsGetInboxMessagesCountTypeParameter | Filter by inbox message type (`level_start`, `level_info`, `level_end`, `transfer`, `external`, `migration`).   Click on the parameter to expand more details.
$sort = new \Bzzhh\Tzkt\Model\AccountsGetSortParameter(); // AccountsGetSortParameter | Sorts items (asc or desc) by the specified field. You can see what fields can be used for sorting in the response description, below.   Click on the parameter to expand more details.
$offset = new \Bzzhh\Tzkt\Model\AccountsGetOffsetParameter(); // AccountsGetOffsetParameter | Specifies which or how many items should be skipped.   Click on the parameter to expand more details.
$limit = 56; // int | Maximum number of items to return.
$select = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysSelectParameter(); // BigMapsGetBigMapKeysSelectParameter | Specify a comma-separated list of fields to include into response or leave it undefined to get default set of fields. This parameter accepts values of the following format: `{field}{path?}{as alias?}`, so you can do deep selection (for example, `?select=balance,token.metadata.symbol as token,...`).   Note, if you select just one field, the response will be flatten into a simple array of values.   Click on the parameter to expand the details.
$micheline = new \Bzzhh\Tzkt\Model\AccountsGetOperationsMichelineParameter(); // AccountsGetOperationsMichelineParameter | Format of smart rollup call parameters: `0` - JSON, `1` - JSON string, `2` - raw micheline, `3` - raw micheline string

try {
    $result = $apiInstance->smartRollupsGetInboxMessages($id, $level, $timestamp, $type, $sort, $offset, $limit, $select, $micheline);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SmartRollupsApi->smartRollupsGetInboxMessages: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id AccountsGetIdParameter Filter by internal TzKT id. Click on the parameter to expand more details. [optional]
level AccountsGetIdParameter Filter by level of the block, where the message was pushed. Click on the parameter to expand more details. [optional]
timestamp BigMapsGetBigMapKeysFirstTimeParameter Filter by timestamp of the block, where the message was pushed. Click on the parameter to expand more details. [optional]
type SmartRollupsGetInboxMessagesCountTypeParameter Filter by inbox message type (`level_start`, `level_info`, `level_end`, `transfer`, `external`, `migration`). Click on the parameter to expand more details. [optional]
sort AccountsGetSortParameter Sorts items (asc or desc) by the specified field. You can see what fields can be used for sorting in the response description, below. Click on the parameter to expand more details. [optional]
offset AccountsGetOffsetParameter Specifies which or how many items should be skipped. Click on the parameter to expand more details. [optional]
limit int Maximum number of items to return. [optional]
select BigMapsGetBigMapKeysSelectParameter Specify a comma-separated list of fields to include into response or leave it undefined to get default set of fields. This parameter accepts values of the following format: `{field}{path?}{as alias?}`, so you can do deep selection (for example, `?select=balance,token.metadata.symbol as token,...`). Note, if you select just one field, the response will be flatten into a simple array of values. Click on the parameter to expand the details. [optional]
micheline AccountsGetOperationsMichelineParameter Format of smart rollup call parameters: `0` - JSON, `1` - JSON string, `2` - raw micheline, `3` - raw micheline string [optional]

Return type

\Bzzhh\Tzkt\Model\SrMessage[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

smartRollupsGetInboxMessagesCount()

smartRollupsGetInboxMessagesCount($id, $level, $timestamp, $type): int

Get inbox messages count

Returns a total number of smart rollup inbox messages.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\SmartRollupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by internal TzKT id.   Click on the parameter to expand more details.
$level = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by level of the block, where the message was pushed.   Click on the parameter to expand more details.
$timestamp = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysFirstTimeParameter(); // BigMapsGetBigMapKeysFirstTimeParameter | Filter by timestamp of the block, where the message was pushed.   Click on the parameter to expand more details.
$type = new \Bzzhh\Tzkt\Model\SmartRollupsGetInboxMessagesCountTypeParameter(); // SmartRollupsGetInboxMessagesCountTypeParameter | Filter by inbox message type (`level_start`, `level_info`, `level_end`, `transfer`, `external`, `migration`).   Click on the parameter to expand more details.

try {
    $result = $apiInstance->smartRollupsGetInboxMessagesCount($id, $level, $timestamp, $type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SmartRollupsApi->smartRollupsGetInboxMessagesCount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id AccountsGetIdParameter Filter by internal TzKT id. Click on the parameter to expand more details. [optional]
level AccountsGetIdParameter Filter by level of the block, where the message was pushed. Click on the parameter to expand more details. [optional]
timestamp BigMapsGetBigMapKeysFirstTimeParameter Filter by timestamp of the block, where the message was pushed. Click on the parameter to expand more details. [optional]
type SmartRollupsGetInboxMessagesCountTypeParameter Filter by inbox message type (`level_start`, `level_info`, `level_end`, `transfer`, `external`, `migration`). Click on the parameter to expand more details. [optional]

Return type

int

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

smartRollupsGetInterface()

smartRollupsGetInterface($address): \Bzzhh\Tzkt\Model\ContractInterface

Get JSON Schema [2020-12] interface for the smart rollup

Returns standard JSON Schema for smart rollup parameter.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\SmartRollupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$address = 'address_example'; // string | Smart rollup address

try {
    $result = $apiInstance->smartRollupsGetInterface($address);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SmartRollupsApi->smartRollupsGetInterface: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
address string Smart rollup address

Return type

\Bzzhh\Tzkt\Model\ContractInterface

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

smartRollupsGetSmartRollup()

smartRollupsGetSmartRollup($address): \Bzzhh\Tzkt\Model\SmartRollup

Get smart rollup by address

Returns a smart rollup with the specified address.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\SmartRollupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$address = 'address_example'; // string | Smart rollup address

try {
    $result = $apiInstance->smartRollupsGetSmartRollup($address);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SmartRollupsApi->smartRollupsGetSmartRollup: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
address string Smart rollup address

Return type

\Bzzhh\Tzkt\Model\SmartRollup

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

smartRollupsGetSmartRollupCommitments()

smartRollupsGetSmartRollupCommitments($id, $initiator, $rollup, $inbox_level, $hash, $first_level, $first_time, $last_level, $last_time, $status, $predecessor_id, $predecessor_hash, $sort, $offset, $limit, $select): \Bzzhh\Tzkt\Model\SrCommitment[]

Get smart rollup commitments

Returns a list of smart rollup commitments.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\SmartRollupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by internal TzKT id.   Click on the parameter to expand more details.
$initiator = new \Bzzhh\Tzkt\Model\AccountsGetDelegateParameter(); // AccountsGetDelegateParameter | Filter by initiator (an account published the commitment first).   Click on the parameter to expand more details.
$rollup = new \Bzzhh\Tzkt\Model\AccountsGetDelegateParameter(); // AccountsGetDelegateParameter | Filter by smart rollup.   Click on the parameter to expand more details.
$inbox_level = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by inbox level.   Click on the parameter to expand more details.
$hash = new \Bzzhh\Tzkt\Model\OperationsGetSmartRollupPublishOpsCommitmentHashParameter(); // OperationsGetSmartRollupPublishOpsCommitmentHashParameter | Filter by commitment hash.   Click on the parameter to expand more details.
$first_level = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by level of the block, where the commitment was first seen.   Click on the parameter to expand more details.
$first_time = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysFirstTimeParameter(); // BigMapsGetBigMapKeysFirstTimeParameter | Filter by timestamp of the block, where the commitment was first seen.   Click on the parameter to expand more details.
$last_level = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by level of the block, where the commitment was last seen.   Click on the parameter to expand more details.
$last_time = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysFirstTimeParameter(); // BigMapsGetBigMapKeysFirstTimeParameter | Filter by timestamp of the block, where the commitment was last seen.   Click on the parameter to expand more details.
$status = new \Bzzhh\Tzkt\Model\SmartRollupsGetSmartRollupCommitmentsCountStatusParameter(); // SmartRollupsGetSmartRollupCommitmentsCountStatusParameter | Filter by commitment status (`pending`, `cemented`, `executed`, `refuted`, or `orphan`).   Click on the parameter to expand more details.
$predecessor_id = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by internal TzKT id.   Click on the parameter to expand more details.
$predecessor_hash = new \Bzzhh\Tzkt\Model\OperationsGetSmartRollupPublishOpsCommitmentHashParameter(); // OperationsGetSmartRollupPublishOpsCommitmentHashParameter | Filter by commitment hash.   Click on the parameter to expand more details.
$sort = new \Bzzhh\Tzkt\Model\AccountsGetSortParameter(); // AccountsGetSortParameter | Sorts items (asc or desc) by the specified field. You can see what fields can be used for sorting in the response description, below.   Click on the parameter to expand more details.
$offset = new \Bzzhh\Tzkt\Model\AccountsGetOffsetParameter(); // AccountsGetOffsetParameter | Specifies which or how many items should be skipped.   Click on the parameter to expand more details.
$limit = 56; // int | Maximum number of items to return.
$select = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysSelectParameter(); // BigMapsGetBigMapKeysSelectParameter | Specify a comma-separated list of fields to include into response or leave it undefined to get default set of fields. This parameter accepts values of the following format: `{field}{path?}{as alias?}`, so you can do deep selection (for example, `?select=balance,token.metadata.symbol as token,...`).   Note, if you select just one field, the response will be flatten into a simple array of values.   Click on the parameter to expand the details.

try {
    $result = $apiInstance->smartRollupsGetSmartRollupCommitments($id, $initiator, $rollup, $inbox_level, $hash, $first_level, $first_time, $last_level, $last_time, $status, $predecessor_id, $predecessor_hash, $sort, $offset, $limit, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SmartRollupsApi->smartRollupsGetSmartRollupCommitments: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id AccountsGetIdParameter Filter by internal TzKT id. Click on the parameter to expand more details. [optional]
initiator AccountsGetDelegateParameter Filter by initiator (an account published the commitment first). Click on the parameter to expand more details. [optional]
rollup AccountsGetDelegateParameter Filter by smart rollup. Click on the parameter to expand more details. [optional]
inbox_level AccountsGetIdParameter Filter by inbox level. Click on the parameter to expand more details. [optional]
hash OperationsGetSmartRollupPublishOpsCommitmentHashParameter Filter by commitment hash. Click on the parameter to expand more details. [optional]
first_level AccountsGetIdParameter Filter by level of the block, where the commitment was first seen. Click on the parameter to expand more details. [optional]
first_time BigMapsGetBigMapKeysFirstTimeParameter Filter by timestamp of the block, where the commitment was first seen. Click on the parameter to expand more details. [optional]
last_level AccountsGetIdParameter Filter by level of the block, where the commitment was last seen. Click on the parameter to expand more details. [optional]
last_time BigMapsGetBigMapKeysFirstTimeParameter Filter by timestamp of the block, where the commitment was last seen. Click on the parameter to expand more details. [optional]
status SmartRollupsGetSmartRollupCommitmentsCountStatusParameter Filter by commitment status (`pending`, `cemented`, `executed`, `refuted`, or `orphan`). Click on the parameter to expand more details. [optional]
predecessor_id AccountsGetIdParameter Filter by internal TzKT id. Click on the parameter to expand more details. [optional]
predecessor_hash OperationsGetSmartRollupPublishOpsCommitmentHashParameter Filter by commitment hash. Click on the parameter to expand more details. [optional]
sort AccountsGetSortParameter Sorts items (asc or desc) by the specified field. You can see what fields can be used for sorting in the response description, below. Click on the parameter to expand more details. [optional]
offset AccountsGetOffsetParameter Specifies which or how many items should be skipped. Click on the parameter to expand more details. [optional]
limit int Maximum number of items to return. [optional]
select BigMapsGetBigMapKeysSelectParameter Specify a comma-separated list of fields to include into response or leave it undefined to get default set of fields. This parameter accepts values of the following format: `{field}{path?}{as alias?}`, so you can do deep selection (for example, `?select=balance,token.metadata.symbol as token,...`). Note, if you select just one field, the response will be flatten into a simple array of values. Click on the parameter to expand the details. [optional]

Return type

\Bzzhh\Tzkt\Model\SrCommitment[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

smartRollupsGetSmartRollupCommitmentsCount()

smartRollupsGetSmartRollupCommitmentsCount($id, $initiator, $rollup, $inbox_level, $hash, $first_level, $first_time, $last_level, $last_time, $status, $predecessor_id, $predecessor_hash): int

Get smart rollup commitments count

Returns a total number of smart rollup commitments.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\SmartRollupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by internal TzKT id.   Click on the parameter to expand more details.
$initiator = new \Bzzhh\Tzkt\Model\AccountsGetDelegateParameter(); // AccountsGetDelegateParameter | Filter by initiator (an account published the commitment first).   Click on the parameter to expand more details.
$rollup = new \Bzzhh\Tzkt\Model\AccountsGetDelegateParameter(); // AccountsGetDelegateParameter | Filter by smart rollup.   Click on the parameter to expand more details.
$inbox_level = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by inbox level.   Click on the parameter to expand more details.
$hash = new \Bzzhh\Tzkt\Model\OperationsGetSmartRollupPublishOpsCommitmentHashParameter(); // OperationsGetSmartRollupPublishOpsCommitmentHashParameter | Filter by commitment hash.   Click on the parameter to expand more details.
$first_level = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by level of the block, where the commitment was first seen.   Click on the parameter to expand more details.
$first_time = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysFirstTimeParameter(); // BigMapsGetBigMapKeysFirstTimeParameter | Filter by timestamp of the block, where the commitment was first seen.   Click on the parameter to expand more details.
$last_level = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by level of the block, where the commitment was last seen.   Click on the parameter to expand more details.
$last_time = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysFirstTimeParameter(); // BigMapsGetBigMapKeysFirstTimeParameter | Filter by timestamp of the block, where the commitment was last seen.   Click on the parameter to expand more details.
$status = new \Bzzhh\Tzkt\Model\SmartRollupsGetSmartRollupCommitmentsCountStatusParameter(); // SmartRollupsGetSmartRollupCommitmentsCountStatusParameter | Filter by commitment status (`pending`, `cemented`, `executed`, `refuted`, or `orphan`).   Click on the parameter to expand more details.
$predecessor_id = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by internal TzKT id.   Click on the parameter to expand more details.
$predecessor_hash = new \Bzzhh\Tzkt\Model\OperationsGetSmartRollupPublishOpsCommitmentHashParameter(); // OperationsGetSmartRollupPublishOpsCommitmentHashParameter | Filter by commitment hash.   Click on the parameter to expand more details.

try {
    $result = $apiInstance->smartRollupsGetSmartRollupCommitmentsCount($id, $initiator, $rollup, $inbox_level, $hash, $first_level, $first_time, $last_level, $last_time, $status, $predecessor_id, $predecessor_hash);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SmartRollupsApi->smartRollupsGetSmartRollupCommitmentsCount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id AccountsGetIdParameter Filter by internal TzKT id. Click on the parameter to expand more details. [optional]
initiator AccountsGetDelegateParameter Filter by initiator (an account published the commitment first). Click on the parameter to expand more details. [optional]
rollup AccountsGetDelegateParameter Filter by smart rollup. Click on the parameter to expand more details. [optional]
inbox_level AccountsGetIdParameter Filter by inbox level. Click on the parameter to expand more details. [optional]
hash OperationsGetSmartRollupPublishOpsCommitmentHashParameter Filter by commitment hash. Click on the parameter to expand more details. [optional]
first_level AccountsGetIdParameter Filter by level of the block, where the commitment was first seen. Click on the parameter to expand more details. [optional]
first_time BigMapsGetBigMapKeysFirstTimeParameter Filter by timestamp of the block, where the commitment was first seen. Click on the parameter to expand more details. [optional]
last_level AccountsGetIdParameter Filter by level of the block, where the commitment was last seen. Click on the parameter to expand more details. [optional]
last_time BigMapsGetBigMapKeysFirstTimeParameter Filter by timestamp of the block, where the commitment was last seen. Click on the parameter to expand more details. [optional]
status SmartRollupsGetSmartRollupCommitmentsCountStatusParameter Filter by commitment status (`pending`, `cemented`, `executed`, `refuted`, or `orphan`). Click on the parameter to expand more details. [optional]
predecessor_id AccountsGetIdParameter Filter by internal TzKT id. Click on the parameter to expand more details. [optional]
predecessor_hash OperationsGetSmartRollupPublishOpsCommitmentHashParameter Filter by commitment hash. Click on the parameter to expand more details. [optional]

Return type

int

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

smartRollupsGetSmartRollupGames()

smartRollupsGetSmartRollupGames($id, $rollup, $initiator, $initiator_commitment_id, $initiator_commitment_hash, $opponent, $opponent_commitment_id, $opponent_commitment_hash, $first_level, $first_time, $last_level, $last_time, $sort, $offset, $limit, $select): \Bzzhh\Tzkt\Model\SrGame[]

Get smart rollup games

Returns a list of smart rollup refutation games.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\SmartRollupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by internal TzKT id.   Click on the parameter to expand more details.
$rollup = new \Bzzhh\Tzkt\Model\AccountsGetDelegateParameter(); // AccountsGetDelegateParameter | Filter by smart rollup.   Click on the parameter to expand more details.
$initiator = new \Bzzhh\Tzkt\Model\AccountsGetDelegateParameter(); // AccountsGetDelegateParameter | Filter by initiator (who found a wrong commitment and started the refutation game).   Click on the parameter to expand more details.
$initiator_commitment_id = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by internal TzKT id.   Click on the parameter to expand more details.
$initiator_commitment_hash = new \Bzzhh\Tzkt\Model\OperationsGetSmartRollupPublishOpsCommitmentHashParameter(); // OperationsGetSmartRollupPublishOpsCommitmentHashParameter | Filter by commitment hash.   Click on the parameter to expand more details.
$opponent = new \Bzzhh\Tzkt\Model\AccountsGetDelegateParameter(); // AccountsGetDelegateParameter | Filter by opponent (who was accused in publishing a wrong commitment).   Click on the parameter to expand more details.
$opponent_commitment_id = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by internal TzKT id.   Click on the parameter to expand more details.
$opponent_commitment_hash = new \Bzzhh\Tzkt\Model\OperationsGetSmartRollupPublishOpsCommitmentHashParameter(); // OperationsGetSmartRollupPublishOpsCommitmentHashParameter | Filter by commitment hash.   Click on the parameter to expand more details.
$first_level = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by level of the block, where the refutation game was started.   Click on the parameter to expand more details.
$first_time = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysFirstTimeParameter(); // BigMapsGetBigMapKeysFirstTimeParameter | Filter by timestamp of the block, where the refutation game was started.   Click on the parameter to expand more details.
$last_level = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by level of the block, where the refutation game was last updated.   Click on the parameter to expand more details.
$last_time = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysFirstTimeParameter(); // BigMapsGetBigMapKeysFirstTimeParameter | Filter by timestamp of the block, where the refutation game was last updated.   Click on the parameter to expand more details.
$sort = new \Bzzhh\Tzkt\Model\AccountsGetSortParameter(); // AccountsGetSortParameter | Sorts items (asc or desc) by the specified field. You can see what fields can be used for sorting in the response description, below.   Click on the parameter to expand more details.
$offset = new \Bzzhh\Tzkt\Model\AccountsGetOffsetParameter(); // AccountsGetOffsetParameter | Specifies which or how many items should be skipped.   Click on the parameter to expand more details.
$limit = 56; // int | Maximum number of items to return.
$select = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysSelectParameter(); // BigMapsGetBigMapKeysSelectParameter | Specify a comma-separated list of fields to include into response or leave it undefined to get default set of fields. This parameter accepts values of the following format: `{field}{path?}{as alias?}`, so you can do deep selection (for example, `?select=balance,token.metadata.symbol as token,...`).   Note, if you select just one field, the response will be flatten into a simple array of values.   Click on the parameter to expand the details.

try {
    $result = $apiInstance->smartRollupsGetSmartRollupGames($id, $rollup, $initiator, $initiator_commitment_id, $initiator_commitment_hash, $opponent, $opponent_commitment_id, $opponent_commitment_hash, $first_level, $first_time, $last_level, $last_time, $sort, $offset, $limit, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SmartRollupsApi->smartRollupsGetSmartRollupGames: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id AccountsGetIdParameter Filter by internal TzKT id. Click on the parameter to expand more details. [optional]
rollup AccountsGetDelegateParameter Filter by smart rollup. Click on the parameter to expand more details. [optional]
initiator AccountsGetDelegateParameter Filter by initiator (who found a wrong commitment and started the refutation game). Click on the parameter to expand more details. [optional]
initiator_commitment_id AccountsGetIdParameter Filter by internal TzKT id. Click on the parameter to expand more details. [optional]
initiator_commitment_hash OperationsGetSmartRollupPublishOpsCommitmentHashParameter Filter by commitment hash. Click on the parameter to expand more details. [optional]
opponent AccountsGetDelegateParameter Filter by opponent (who was accused in publishing a wrong commitment). Click on the parameter to expand more details. [optional]
opponent_commitment_id AccountsGetIdParameter Filter by internal TzKT id. Click on the parameter to expand more details. [optional]
opponent_commitment_hash OperationsGetSmartRollupPublishOpsCommitmentHashParameter Filter by commitment hash. Click on the parameter to expand more details. [optional]
first_level AccountsGetIdParameter Filter by level of the block, where the refutation game was started. Click on the parameter to expand more details. [optional]
first_time BigMapsGetBigMapKeysFirstTimeParameter Filter by timestamp of the block, where the refutation game was started. Click on the parameter to expand more details. [optional]
last_level AccountsGetIdParameter Filter by level of the block, where the refutation game was last updated. Click on the parameter to expand more details. [optional]
last_time BigMapsGetBigMapKeysFirstTimeParameter Filter by timestamp of the block, where the refutation game was last updated. Click on the parameter to expand more details. [optional]
sort AccountsGetSortParameter Sorts items (asc or desc) by the specified field. You can see what fields can be used for sorting in the response description, below. Click on the parameter to expand more details. [optional]
offset AccountsGetOffsetParameter Specifies which or how many items should be skipped. Click on the parameter to expand more details. [optional]
limit int Maximum number of items to return. [optional]
select BigMapsGetBigMapKeysSelectParameter Specify a comma-separated list of fields to include into response or leave it undefined to get default set of fields. This parameter accepts values of the following format: `{field}{path?}{as alias?}`, so you can do deep selection (for example, `?select=balance,token.metadata.symbol as token,...`). Note, if you select just one field, the response will be flatten into a simple array of values. Click on the parameter to expand the details. [optional]

Return type

\Bzzhh\Tzkt\Model\SrGame[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

smartRollupsGetSmartRollupGamesCount()

smartRollupsGetSmartRollupGamesCount($id, $rollup, $initiator, $initiator_commitment_id, $initiator_commitment_hash, $opponent, $opponent_commitment_id, $opponent_commitment_hash, $first_level, $first_time, $last_level, $last_time): int

Get smart rollup games count

Returns a total number of smart rollup refutation games.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\SmartRollupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by internal TzKT id.   Click on the parameter to expand more details.
$rollup = new \Bzzhh\Tzkt\Model\AccountsGetDelegateParameter(); // AccountsGetDelegateParameter | Filter by smart rollup.   Click on the parameter to expand more details.
$initiator = new \Bzzhh\Tzkt\Model\AccountsGetDelegateParameter(); // AccountsGetDelegateParameter | Filter by initiator (who found a wrong commitment and started the refutation game).   Click on the parameter to expand more details.
$initiator_commitment_id = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by internal TzKT id.   Click on the parameter to expand more details.
$initiator_commitment_hash = new \Bzzhh\Tzkt\Model\OperationsGetSmartRollupPublishOpsCommitmentHashParameter(); // OperationsGetSmartRollupPublishOpsCommitmentHashParameter | Filter by commitment hash.   Click on the parameter to expand more details.
$opponent = new \Bzzhh\Tzkt\Model\AccountsGetDelegateParameter(); // AccountsGetDelegateParameter | Filter by opponent (who was accused in publishing a wrong commitment).   Click on the parameter to expand more details.
$opponent_commitment_id = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by internal TzKT id.   Click on the parameter to expand more details.
$opponent_commitment_hash = new \Bzzhh\Tzkt\Model\OperationsGetSmartRollupPublishOpsCommitmentHashParameter(); // OperationsGetSmartRollupPublishOpsCommitmentHashParameter | Filter by commitment hash.   Click on the parameter to expand more details.
$first_level = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by level of the block, where the refutation game was started.   Click on the parameter to expand more details.
$first_time = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysFirstTimeParameter(); // BigMapsGetBigMapKeysFirstTimeParameter | Filter by timestamp of the block, where the refutation game was started.   Click on the parameter to expand more details.
$last_level = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by level of the block, where the refutation game was last updated.   Click on the parameter to expand more details.
$last_time = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysFirstTimeParameter(); // BigMapsGetBigMapKeysFirstTimeParameter | Filter by timestamp of the block, where the refutation game was last updated.   Click on the parameter to expand more details.

try {
    $result = $apiInstance->smartRollupsGetSmartRollupGamesCount($id, $rollup, $initiator, $initiator_commitment_id, $initiator_commitment_hash, $opponent, $opponent_commitment_id, $opponent_commitment_hash, $first_level, $first_time, $last_level, $last_time);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SmartRollupsApi->smartRollupsGetSmartRollupGamesCount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id AccountsGetIdParameter Filter by internal TzKT id. Click on the parameter to expand more details. [optional]
rollup AccountsGetDelegateParameter Filter by smart rollup. Click on the parameter to expand more details. [optional]
initiator AccountsGetDelegateParameter Filter by initiator (who found a wrong commitment and started the refutation game). Click on the parameter to expand more details. [optional]
initiator_commitment_id AccountsGetIdParameter Filter by internal TzKT id. Click on the parameter to expand more details. [optional]
initiator_commitment_hash OperationsGetSmartRollupPublishOpsCommitmentHashParameter Filter by commitment hash. Click on the parameter to expand more details. [optional]
opponent AccountsGetDelegateParameter Filter by opponent (who was accused in publishing a wrong commitment). Click on the parameter to expand more details. [optional]
opponent_commitment_id AccountsGetIdParameter Filter by internal TzKT id. Click on the parameter to expand more details. [optional]
opponent_commitment_hash OperationsGetSmartRollupPublishOpsCommitmentHashParameter Filter by commitment hash. Click on the parameter to expand more details. [optional]
first_level AccountsGetIdParameter Filter by level of the block, where the refutation game was started. Click on the parameter to expand more details. [optional]
first_time BigMapsGetBigMapKeysFirstTimeParameter Filter by timestamp of the block, where the refutation game was started. Click on the parameter to expand more details. [optional]
last_level AccountsGetIdParameter Filter by level of the block, where the refutation game was last updated. Click on the parameter to expand more details. [optional]
last_time BigMapsGetBigMapKeysFirstTimeParameter Filter by timestamp of the block, where the refutation game was last updated. Click on the parameter to expand more details. [optional]

Return type

int

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

smartRollupsGetSmartRollupStakers()

smartRollupsGetSmartRollupStakers($address, $id, $bond_status, $sort, $offset, $limit, $select): \Bzzhh\Tzkt\Model\SrStaker[]

Get smart rollup stakers

Returns a list of smart rollup stakers.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\SmartRollupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$address = array('key' => new \Bzzhh\Tzkt\Model\AddressParameter()); // AddressParameter | Filter by smart rollup staker address.   Click on the parameter to expand more details.
$id = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by internal TzKT id.   Click on the parameter to expand more details.
$bond_status = new \Bzzhh\Tzkt\Model\SmartRollupsGetSmartRollupStakersBondStatusParameter(); // SmartRollupsGetSmartRollupStakersBondStatusParameter | Filter by staker bond status (`active`, `returned`, or `lost`).   Click on the parameter to expand more details.
$sort = new \Bzzhh\Tzkt\Model\AccountsGetSortParameter(); // AccountsGetSortParameter | Sorts items (asc or desc) by the specified field. You can see what fields can be used for sorting in the response description, below.   Click on the parameter to expand more details.
$offset = new \Bzzhh\Tzkt\Model\AccountsGetOffsetParameter(); // AccountsGetOffsetParameter | Specifies which or how many items should be skipped.   Click on the parameter to expand more details.
$limit = 56; // int | Maximum number of items to return.
$select = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysSelectParameter(); // BigMapsGetBigMapKeysSelectParameter | Specify a comma-separated list of fields to include into response or leave it undefined to get default set of fields. This parameter accepts values of the following format: `{field}{path?}{as alias?}`, so you can do deep selection (for example, `?select=balance,token.metadata.symbol as token,...`).   Note, if you select just one field, the response will be flatten into a simple array of values.   Click on the parameter to expand the details.

try {
    $result = $apiInstance->smartRollupsGetSmartRollupStakers($address, $id, $bond_status, $sort, $offset, $limit, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SmartRollupsApi->smartRollupsGetSmartRollupStakers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
address AddressParameter Filter by smart rollup staker address. Click on the parameter to expand more details.
id AccountsGetIdParameter Filter by internal TzKT id. Click on the parameter to expand more details. [optional]
bond_status SmartRollupsGetSmartRollupStakersBondStatusParameter Filter by staker bond status (`active`, `returned`, or `lost`). Click on the parameter to expand more details. [optional]
sort AccountsGetSortParameter Sorts items (asc or desc) by the specified field. You can see what fields can be used for sorting in the response description, below. Click on the parameter to expand more details. [optional]
offset AccountsGetOffsetParameter Specifies which or how many items should be skipped. Click on the parameter to expand more details. [optional]
limit int Maximum number of items to return. [optional]
select BigMapsGetBigMapKeysSelectParameter Specify a comma-separated list of fields to include into response or leave it undefined to get default set of fields. This parameter accepts values of the following format: `{field}{path?}{as alias?}`, so you can do deep selection (for example, `?select=balance,token.metadata.symbol as token,...`). Note, if you select just one field, the response will be flatten into a simple array of values. Click on the parameter to expand the details. [optional]

Return type

\Bzzhh\Tzkt\Model\SrStaker[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

smartRollupsGetSmartRollups()

smartRollupsGetSmartRollups($id, $address, $creator, $first_activity, $first_activity_time, $last_activity, $last_activity_time, $sort, $offset, $limit, $select): \Bzzhh\Tzkt\Model\SmartRollup[]

Get smart rollups

Returns a list of smart rollups.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\SmartRollupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by internal TzKT id.   Click on the parameter to expand more details.
$address = new \Bzzhh\Tzkt\Model\AccountsGetAddressParameter(); // AccountsGetAddressParameter | Filter by smart rollup address.   Click on the parameter to expand more details.
$creator = new \Bzzhh\Tzkt\Model\AccountsGetDelegateParameter(); // AccountsGetDelegateParameter | Filter by smart rollup creator.   Click on the parameter to expand more details.
$first_activity = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by level of the block, where the rollup was first seen.   Click on the parameter to expand more details.
$first_activity_time = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysFirstTimeParameter(); // BigMapsGetBigMapKeysFirstTimeParameter | Filter by timestamp of the block, where the rollup was first seen.   Click on the parameter to expand more details.
$last_activity = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by level of the block, where the rollup was last seen.   Click on the parameter to expand more details.
$last_activity_time = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysFirstTimeParameter(); // BigMapsGetBigMapKeysFirstTimeParameter | Filter by timestamp of the block, where the rollup was last seen.   Click on the parameter to expand more details.
$sort = new \Bzzhh\Tzkt\Model\AccountsGetSortParameter(); // AccountsGetSortParameter | Sorts items (asc or desc) by the specified field. You can see what fields can be used for sorting in the response description, below.   Click on the parameter to expand more details.
$offset = new \Bzzhh\Tzkt\Model\AccountsGetOffsetParameter(); // AccountsGetOffsetParameter | Specifies which or how many items should be skipped.   Click on the parameter to expand more details.
$limit = 56; // int | Maximum number of items to return.
$select = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysSelectParameter(); // BigMapsGetBigMapKeysSelectParameter | Specify a comma-separated list of fields to include into response or leave it undefined to get default set of fields. This parameter accepts values of the following format: `{field}{path?}{as alias?}`, so you can do deep selection (for example, `?select=balance,token.metadata.symbol as token,...`).   Note, if you select just one field, the response will be flatten into a simple array of values.   Click on the parameter to expand the details.

try {
    $result = $apiInstance->smartRollupsGetSmartRollups($id, $address, $creator, $first_activity, $first_activity_time, $last_activity, $last_activity_time, $sort, $offset, $limit, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SmartRollupsApi->smartRollupsGetSmartRollups: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id AccountsGetIdParameter Filter by internal TzKT id. Click on the parameter to expand more details. [optional]
address AccountsGetAddressParameter Filter by smart rollup address. Click on the parameter to expand more details. [optional]
creator AccountsGetDelegateParameter Filter by smart rollup creator. Click on the parameter to expand more details. [optional]
first_activity AccountsGetIdParameter Filter by level of the block, where the rollup was first seen. Click on the parameter to expand more details. [optional]
first_activity_time BigMapsGetBigMapKeysFirstTimeParameter Filter by timestamp of the block, where the rollup was first seen. Click on the parameter to expand more details. [optional]
last_activity AccountsGetIdParameter Filter by level of the block, where the rollup was last seen. Click on the parameter to expand more details. [optional]
last_activity_time BigMapsGetBigMapKeysFirstTimeParameter Filter by timestamp of the block, where the rollup was last seen. Click on the parameter to expand more details. [optional]
sort AccountsGetSortParameter Sorts items (asc or desc) by the specified field. You can see what fields can be used for sorting in the response description, below. Click on the parameter to expand more details. [optional]
offset AccountsGetOffsetParameter Specifies which or how many items should be skipped. Click on the parameter to expand more details. [optional]
limit int Maximum number of items to return. [optional]
select BigMapsGetBigMapKeysSelectParameter Specify a comma-separated list of fields to include into response or leave it undefined to get default set of fields. This parameter accepts values of the following format: `{field}{path?}{as alias?}`, so you can do deep selection (for example, `?select=balance,token.metadata.symbol as token,...`). Note, if you select just one field, the response will be flatten into a simple array of values. Click on the parameter to expand the details. [optional]

Return type

\Bzzhh\Tzkt\Model\SmartRollup[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

smartRollupsGetSmartRollupsCount()

smartRollupsGetSmartRollupsCount($id, $address, $creator, $first_activity, $first_activity_time, $last_activity, $last_activity_time): int

Get smart rollups count

Returns a total number of smart rollups.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Bzzhh\Tzkt\Api\SmartRollupsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by internal TzKT id.   Click on the parameter to expand more details.
$address = new \Bzzhh\Tzkt\Model\AccountsGetAddressParameter(); // AccountsGetAddressParameter | Filter by smart rollup address.   Click on the parameter to expand more details.
$creator = new \Bzzhh\Tzkt\Model\AccountsGetDelegateParameter(); // AccountsGetDelegateParameter | Filter by smart rollup creator.   Click on the parameter to expand more details.
$first_activity = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by level of the block, where the rollup was first seen.   Click on the parameter to expand more details.
$first_activity_time = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysFirstTimeParameter(); // BigMapsGetBigMapKeysFirstTimeParameter | Filter by timestamp of the block, where the rollup was first seen.   Click on the parameter to expand more details.
$last_activity = new \Bzzhh\Tzkt\Model\AccountsGetIdParameter(); // AccountsGetIdParameter | Filter by level of the block, where the rollup was last seen.   Click on the parameter to expand more details.
$last_activity_time = new \Bzzhh\Tzkt\Model\BigMapsGetBigMapKeysFirstTimeParameter(); // BigMapsGetBigMapKeysFirstTimeParameter | Filter by timestamp of the block, where the rollup was last seen.   Click on the parameter to expand more details.

try {
    $result = $apiInstance->smartRollupsGetSmartRollupsCount($id, $address, $creator, $first_activity, $first_activity_time, $last_activity, $last_activity_time);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SmartRollupsApi->smartRollupsGetSmartRollupsCount: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id AccountsGetIdParameter Filter by internal TzKT id. Click on the parameter to expand more details. [optional]
address AccountsGetAddressParameter Filter by smart rollup address. Click on the parameter to expand more details. [optional]
creator AccountsGetDelegateParameter Filter by smart rollup creator. Click on the parameter to expand more details. [optional]
first_activity AccountsGetIdParameter Filter by level of the block, where the rollup was first seen. Click on the parameter to expand more details. [optional]
first_activity_time BigMapsGetBigMapKeysFirstTimeParameter Filter by timestamp of the block, where the rollup was first seen. Click on the parameter to expand more details. [optional]
last_activity AccountsGetIdParameter Filter by level of the block, where the rollup was last seen. Click on the parameter to expand more details. [optional]
last_activity_time BigMapsGetBigMapKeysFirstTimeParameter Filter by timestamp of the block, where the rollup was last seen. Click on the parameter to expand more details. [optional]

Return type

int

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]