Skip to content

Instantly share code, notes, and snippets.

@dskvr
Last active November 11, 2022 09:19
Show Gist options
  • Save dskvr/e0fb49890885251dc94e46ef3058243a to your computer and use it in GitHub Desktop.
Save dskvr/e0fb49890885251dc94e46ef3058243a to your computer and use it in GitHub Desktop.
EOSIO OAS 3.0 File - Alpha 0.0.1 (bundled from json-schemas)
openapi: 3.0.0
info:
title: Chain API
version: 1.0.0
license:
name: MIT
url: 'https://opensource.org/licenses/MIT'
contact:
url: 'https://eos.io'
tags:
- name: eosio
servers:
- url: '{protocol}://{host}:{port}/v1/chain'
variables:
protocol:
enum:
- http
- https
default: http
host:
default: http://jungle2.cryptolions.io
port:
default: '80'
components:
securitySchemes: {}
schemas: {}
security:
- {}
paths:
/get_account:
post:
tags:
- Chain
summary: get_account
description: Returns an object containing various details about a specific account on the blockchain.
operationId: get_account
parameters: []
deprecated: false
requestBody:
description: JSON Object with single member 'account_name'
content:
application/json:
schema:
type: object
required:
- account_name
properties:
account_name:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
additionalProperties: false
minProperties: 18
required:
- account_name
- head_block_num
- head_block_time
- last_code_update
- created
- refund_request
- ram_quota
- net_limit
- cpu_limit
- total_resources
- core_liquid_balance
- self_delegated_bandwidth
- net_weight
- cpu_weight
- ram_usage
- privileged
- permissions
- voter_info
properties:
account_name:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
head_block_num:
type: integer
head_block_time:
$ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/timestamp'
last_code_update:
$ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/timestamp'
created:
$ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/timestamp'
refund_request:
type: object
additionalProperties: false
minProperties: 4
required:
- owner
- request_time
- net_amount
- cpu_amount
properties:
owner:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
request_time:
type: string
net_amount:
$ref: '#/paths/~1get_currency_balance/post/responses/200/content/application~1json/schema/items'
cpu_amount:
$ref: '#/paths/~1get_currency_balance/post/responses/200/content/application~1json/schema/items'
title: RefundRequest
nullable: true
ram_quota:
$ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/block_num'
net_limit:
type: object
additionalProperties: false
minProperties: 3
required:
- max
- available
- used
properties:
max:
$ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/block_num'
available:
$ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/block_num'
used:
$ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/block_num'
title: ResourceLimits
cpu_limit:
$ref: '#/paths/~1get_account/post/responses/200/content/application~1json/schema/properties/net_limit'
total_resources:
type: object
additionalProperties: false
minProperties: 4
required:
- owner
- ram_bytes
- net_weight
- cpu_weight
properties:
owner:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
ram_bytes:
$ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/block_num'
net_weight:
$ref: '#/paths/~1get_currency_balance/post/responses/200/content/application~1json/schema/items'
cpu_weight:
$ref: '#/paths/~1get_currency_balance/post/responses/200/content/application~1json/schema/items'
title: ResourceOverview
core_liquid_balance:
$ref: '#/paths/~1get_currency_balance/post/responses/200/content/application~1json/schema/items'
self_delegated_bandwidth:
type: object
additionalProperties: false
minProperties: 4
required:
- from
- to
- net_weight
- cpu_weight
properties:
from:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
to:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
net_weight:
$ref: '#/paths/~1get_currency_balance/post/responses/200/content/application~1json/schema/items'
cpu_weight:
$ref: '#/paths/~1get_currency_balance/post/responses/200/content/application~1json/schema/items'
title: ResourceDelegation
nullable: true
net_weight:
$ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/block_num'
cpu_weight:
$ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/block_num'
ram_usage:
$ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/block_num'
privileged:
type: boolean
permissions:
type: array
items:
type: object
additionalProperties: false
minProperties: 3
required:
- parent
- perm_name
- required_auth
properties:
parent:
description: 'The parent of this permission, if any'
type: string
perm_name:
description: Name of this permission
type: string
required_auth:
type: object
additionalProperties: false
minProperties: 4
required:
- waits
- keys
- threshold
- accounts
properties:
waits:
type: array
items:
type: object
minProperties: 2
additionalProperties: false
required:
- wait_sec
- weight
properties:
wait_sec:
type: integer
weight:
type: integer
title: Wait
keys:
type: array
items:
type: object
additionalProperties: false
required:
- key
- weight
properties:
key:
$ref: '#/paths/~1get_required_keys/post/requestBody/content/application~1json/schema/properties/available_keys/items'
weight:
type: integer
title: KeyAuthority
threshold:
type: integer
accounts:
type: array
items:
type: object
additionalProperties: false
required:
- weight
- permission
properties:
weight:
type: integer
permission:
$ref: '#/paths/~1push_transactions/post/requestBody/content/application~1json/schema/items/properties/actions/items/properties/authorization/items'
title: AccountAuthority
title: RequiredAuthority
title: Permission
voter_info:
type: object
additionalProperties: false
minProperties: 10
required:
- owner
- proxy
- producers
- staked
- last_vote_weight
- proxied_vote_weight
- is_proxy
- flags1
- reserved2
- reserved3
properties:
owner:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
proxy:
oneOf:
- $ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
- $ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/producer/oneOf/0'
producers:
type: array
items:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
staked:
$ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/block_num'
last_vote_weight:
type: string
proxied_vote_weight:
type: string
is_proxy:
description: '1 if true, 0 if false.'
type: integer
flags1:
type: integer
reserved2:
type: integer
reserved3:
$ref: '#/paths/~1get_currency_balance/post/responses/200/content/application~1json/schema/items'
title: VoterInfo
nullable: true
title: Account
/get_block:
post:
tags:
- Chain
summary: get_block
description: Returns an object containing various details about a specific block on the blockchain.
operationId: get_block
parameters: []
deprecated: false
requestBody:
content:
application/json:
schema:
type: object
required:
- block_num_or_id
properties:
block_num_or_id:
type: string
description: Provide a `block number` or a `block id`
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema'
/get_info:
post:
tags:
- Chain
summary: get_info
description: Returns an object containing various details about the blockchain.
operationId: get_info
parameters: []
deprecated: false
security: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- server_version
- chain_id
- head_block_num
- head_block_id
- head_block_time
- head_block_producer
- last_irreversible_block_num
- last_irreversible_block_id
- virtual_block_cpu_limit
- virtual_block_net_limit
- block_cpu_limit
- block_new_limit
- server_version_string
properties:
server_version:
type: string
description: Hash representing the last commit in the tagged release
chain_id:
type: string
description: Hash representing the ID of the chain
head_block_num:
type: integer
description: Highest block number on the chain
head_block_id:
type: string
description: Highest block ID on the chain
head_block_time:
type: string
description: Highest block unix timestamp
head_block_producer:
type: string
description: Producer that signed the highest block (head block)
last_irreversible_block_num:
type: integer
description: Highest block number on the chain that has been irreversibly applied to state
last_irreversible_block_id:
type: string
description: Highest block ID on the chain that has been irreversibly applied to state
virtual_block_cpu_limit:
type: integer
description: 'CPU limit calculated after each block is produced, approximately 1000 times block_cpu_limit'
virtual_block_net_limit:
type: integer
description: 'NET limit calculated after each block is produced, approximately 1000 times block_net_limit'
block_cpu_limit:
type: integer
description: Actual maximum CPU limit
block_new_limit:
type: integer
description: Actual maximum NET limit
server_version_string:
type: string
description: String representation of server version - Majorish-Minorish-Patchy - Warning - Not actually SEMVER!
title: Info
/push_transaction:
post:
tags:
- Chain
summary: push_transaction
description: This method expects a transaction in JSON format and will attempt to apply it to the blockchain.
operationId: push_transaction
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
signatures:
type: array
description: array of signatures required to authorize transaction
items:
type: string
description: String representation of an EOSIO compatible cryptographic signature
pattern: '^SIG_[RK]{1}[0-9]{1}_[A-z0-9]+$'
title: Signature
compression:
type: boolean
description: 'compression used, usually false'
packed_context_free_data:
type: string
description: json to hex
packed_trx:
type: string
description: Transaction object json to hex
responses:
'200':
description: OK
content:
application/json:
schema:
description: Returns Nothing
/push_transactions:
post:
tags:
- Chain
summary: push_transactions
description: This method expects a transaction in JSON format and will attempt to apply it to the blockchain.
operationId: push_transactions
parameters: []
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
additionalProperties: false
minProperties: 9
required:
- expiration
- ref_block_num
- ref_block_prefix
- max_net_usage_words
- max_cpu_usage_ms
- delay_sec
- context_free_actions
- actions
- transaction_extensions
properties:
expiration:
description: Time that transaction must be confirmed by.
type: string
pattern: '^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$'
title: DateTime
ref_block_num:
type: integer
ref_block_prefix:
type: integer
max_net_usage_words:
$ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/block_num'
max_cpu_usage_ms:
$ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/block_num'
delay_sec:
type: integer
context_free_actions:
type: array
items:
$ref: '#/paths/~1push_transactions/post/requestBody/content/application~1json/schema/items/properties/actions/items'
actions:
type: array
items:
type: object
additionalProperties: false
minProperties: 5
required:
- account
- name
- authorization
- data
- hex_data
properties:
account:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
name:
$ref: '#/paths/~1get_abi/post/responses/200/content/application~1json/schema/properties/tables/items/properties/type'
authorization:
type: array
items:
type: object
additionalProperties: false
minProperties: 2
required:
- actor
- permission
properties:
actor:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
permission:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
title: Authority
data:
type: object
additionalProperties: true
hex_data:
type: string
title: Action
transaction_extensions:
type: array
items:
$ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/block_extensions/items'
title: Transaction
responses:
'200':
description: OK
content:
application/json:
schema:
description: Returns Nothing
/get_block_header_state:
post:
tags:
- Chain
summary: get_block_header_state
description: ''
operationId: get_block_header_state
parameters: []
deprecated: false
requestBody:
content:
application/json:
schema:
type: object
required:
- block_num_or_id
properties:
block_num_or_id:
type: string
description: Provide a `block number` or a `block id`
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
additionalProperties: false
minProperties: 16
required:
- id
- block_num
- header
- dpos_proposed_irreversible_blocknum
- dpos_irreversible_blocknum
- bft_irreversible_blocknum
- pending_schedule_lib_num
- pending_schedule_hash
- pending_schedule
- active_schedule
- blockroot_merkle
- producer_to_last_produced
- producer_to_last_implied_irb
- block_signing_key
- confirm_count
- confirmations
properties:
id:
type: string
description: ID of block
block_num:
type: integer
description: Incremented number of block
header:
$ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema'
dpos_proposed_irreversible_blocknum:
$ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/block_num'
dpos_irreversible_blocknum:
$ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/block_num'
bft_irreversible_blocknum:
$ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/block_num'
pending_schedule_lib_num:
$ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/block_num'
pending_schedule_hash:
$ref: '#/paths/~1get_code/post/responses/200/content/application~1json/schema/properties/code_hash'
pending_schedule:
$ref: '#/paths/~1get_block_header_state/post/responses/200/content/application~1json/schema/properties/active_schedule'
active_schedule:
type: object
additionalProperties: false
minProperties: 2
required:
- version
- producers
properties:
version:
type: integer
producers:
type: array
items:
type: object
additionalProperties: false
minProperties: 2
required:
- producer_name
- block_signing_key
properties:
producer_name:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
block_signing_key:
$ref: '#/paths/~1get_required_keys/post/requestBody/content/application~1json/schema/properties/available_keys/items'
title: ProducerSigningKey
title: Schedule
blockroot_merkle:
type: object
additionalProperties: false
minProperties: 2
required:
- _active_nodes
- _node_count
properties:
_active_nodes:
type: array
items:
$ref: '#/paths/~1get_code/post/responses/200/content/application~1json/schema/properties/code_hash'
_node_count:
$ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/block_num'
title: BlockrootMerkle
producer_to_last_produced:
type: array
items:
type: array
items:
anyOf:
- $ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
- $ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/block_num'
producer_to_last_implied_irb:
type: array
items:
type: array
items:
anyOf:
- $ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
- $ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/block_num'
block_signing_key:
$ref: '#/paths/~1get_required_keys/post/requestBody/content/application~1json/schema/properties/available_keys/items'
confirm_count:
type: array
items:
$ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/block_num'
confirmations:
type: array
items: {}
title: BlockHeaderState
/get_abi:
post:
tags:
- Chain
summary: get_abi
description: ''
operationId: get_abi
parameters: []
deprecated: false
requestBody:
content:
application/json:
schema:
type: object
required:
- account_name
properties:
account_name:
type: string
description: String representation of EOSIO name type
pattern: '^([a-z1-5]{1}[a-z1-5\.]{0,10}[a-z1-5]{1})$'
title: Name
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- version
- types
- structs
- actions
- tables
- abi_extensions
- error_messages
- ricardian_clauses
- variants
properties:
version:
type: string
types:
type: array
items:
type: object
additionalProperties: false
minProperties: 2
required:
- new_type_name
- type
properties:
new_type_name:
$ref: '#/paths/~1get_abi/post/responses/200/content/application~1json/schema/properties/tables/items/properties/type'
type:
type: string
description: Native and EOSIO types
enum:
- uint8
- uint16
- uint32
- uint64
- uint128
- float32
- float64
- float128
- bytes
- name
- string
- time_point
- time_point_sec
- symbol_code
- symbol
- asset
- checksum160
- checksum256
- checksum521
- public_key
- private_key
- signature
- account_name
- action_name
title: Type
title: AbiType
structs:
type: array
items:
type: object
additionalProperties: false
minProperties: 3
required:
- name
- base
- fields
properties:
name:
$ref: '#/paths/~1get_abi/post/responses/200/content/application~1json/schema/properties/tables/items/properties/type'
base:
type: string
fields:
type: array
items:
type: object
additionalProperties: false
minProperties: 2
required:
- name
- type
properties:
name:
$ref: '#/paths/~1get_abi/post/responses/200/content/application~1json/schema/properties/tables/items/properties/type'
type:
$ref: '#/paths/~1get_abi/post/responses/200/content/application~1json/schema/properties/types/items/properties/type'
title: AbiStructFields
title: AbiStruct
actions:
type: array
items:
type: object
additionalProperties: false
required:
- name
- type
- ricardian_contract
properties:
name:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
type:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
ricardian_contract:
type: string
minLength: 0
title: AbiAction
tables:
type: array
items:
type: object
additionalProperties: false
minProperties: 5
required:
- name
- index_type
properties:
name:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
index_type:
type: string
enum:
- i64
title: IndexType
key_names:
type: array
items:
$ref: '#/paths/~1get_abi/post/responses/200/content/application~1json/schema/properties/tables/items/properties/type'
key_types:
type: array
items:
type: string
enum:
- uint64
- double
title: KeyType
type:
type: string
description: String representation of EOSIO name type
pattern: '^([a-z1-5]{1}[a-z1-5_]{0,30}[a-z1-5]{1})$'
title: Var
title: AbiTable
abi_extensions:
type: array
items:
$ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/block_extensions/items'
error_messages:
type: array
items:
type: string
ricardian_clauses:
type: array
items:
type: string
variants:
type: array
items:
type: string
title: Abi
/get_currency_balance:
post:
tags:
- Chain
summary: get_currency_balance
description: ''
operationId: get_currency_balance
deprecated: false
requestBody:
content:
application/json:
schema:
type: object
required:
- code
- account
- symbol
properties:
code:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
account:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
symbol:
$ref: '#/paths/~1get_currency_balance/post/responses/200/content/application~1json/schema/items'
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
type: string
description: 'A string representation of an EOSIO symbol, composed of a float with a precision of 4, and a symbol composed of capital letters between 3-7 letters separated by a space, example `1.0000 ABC`.'
pattern: '^([0-9]{1,32}.[0-9]{1,4} [A-Z]{1,7})$'
title: Symbol
/get_currency_stats:
post:
tags:
- Chain
summary: get_currency_stats
description: ''
operationId: get_currency_stats
deprecated: false
requestBody:
content:
application/json:
schema:
type: object
properties:
code:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
symbol:
$ref: '#/paths/~1get_currency_balance/post/responses/200/content/application~1json/schema/items'
responses:
'200':
description: OK
content:
application/json:
schema: {}
/get_required_keys:
post:
tags:
- Chain
summary: get_required_keys
description: Returns the required keys needed to sign a transaction.
operationId: get_required_keys
parameters: []
deprecated: false
requestBody:
content:
application/json:
schema:
type: object
required:
- transaction
- available_keys
properties:
transaction:
$ref: '#/paths/~1push_transactions/post/requestBody/content/application~1json/schema/items'
available_keys:
type: array
description: Provide the available keys
items:
type: string
description: String representation of EOSIO public key type
pattern: '[A-Z]{3}[A-z0-9]{50}'
title: PublicKey
responses:
'200':
description: OK
content:
application/json:
schema:
description: 'Some response, cannot get API to give response. Gotta love non-verbose http errors :D'
/get_producers:
post:
tags:
- Chain
summary: get_producers
description: ''
operationId: get_producers
parameters: []
requestBody:
content:
application/json:
schema:
type: object
required:
- limit
- lower_bound
properties:
limit:
type: string
description: total number of producers to retrieve
lower_bound:
type: string
description: 'In conjunction with limit can be used to paginate through the results. For example, limit=10 and lower_bound=10 would be page 2.'
json:
type: boolean
description: return result in JSON format
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
additionalProperties: false
minProperties: 3
required:
- active
- pending
- proposed
properties:
active:
type: array
items:
$ref: '#/paths/~1get_block_header_state/post/responses/200/content/application~1json/schema/properties/active_schedule'
nullable: true
pending:
type: array
items:
$ref: '#/paths/~1get_block_header_state/post/responses/200/content/application~1json/schema/properties/active_schedule'
nullable: true
proposed:
type: array
items:
$ref: '#/paths/~1get_block_header_state/post/responses/200/content/application~1json/schema/properties/active_schedule'
nullable: true
title: ProducerSchedule
/get_raw_code_and_abi:
post:
tags:
- Chain
summary: get_raw_code_and_abi
description: ''
operationId: get_raw_code_and_abi
parameters: []
deprecated: false
requestBody:
content:
application/json:
schema:
type: object
required:
- account_name
properties:
account_name:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
account_name:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
wasm:
type: string
format: byte
description: base64 encoded wasm
abi:
type: string
format: byte
description: base64 encoded ABI
/get_table_by_scope:
post:
tags:
- Chain
summary: get_table_by_scope
description: ''
operationId: get_table_by_scope
parameters: []
requestBody:
content:
application/json:
schema:
type: object
required:
- code
properties:
code:
type: string
description: '`name` of the contract to return table data for'
table:
type: string
description: Filter results by table
lower_bound:
type: string
description: Filters results to return the first element that is not less than provided value in set
upper_bound:
type: string
description: Filters results to return the first element that is greater than provided value in set
limit:
type: integer
description: Limit number of results returned.
format: int32
reverse:
type: boolean
description: Reverse the order of returned results
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
rows:
type: array
items:
type: object
additionalProperties: false
minProperties: 5
required:
- code
- scope
- table
- payer
- count
properties:
code:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
scope:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
table:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
payer:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
count:
description: Number of matching items.
type: integer
title: TableScope
more:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
/get_table_rows:
post:
tags:
- Chain
summary: get_table_rows
description: Returns an object containing rows from the specified table.
operationId: get_table_rows
parameters: []
requestBody:
content:
application/json:
schema:
type: object
required:
- code
- table
- scope
properties:
code:
type: string
description: The name of the smart contract that controls the provided table
table:
type: string
description: The name of the table to query
scope:
type: string
description: The account to which this data belongs
index_position:
type: string
description: 'Position of the index used, accepted parameters `primary`, `secondary`, `tertiary`, `fourth`, `fifth`, `sixth`, `seventh`, `eighth`, `ninth` , `tenth`'
key_type:
type: string
description: Type of key specified by index_position (for example - `uint64_t` or `name`)
encode_type:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
rows:
type: array
items: {}
/abi_json_to_bin:
post:
tags:
- Chain
summary: abi_json_to_bin
description: Returns an object containing rows from the specified table.
operationId: abi_json_to_bin
parameters: []
requestBody:
content:
application/json:
schema:
type: object
title: AbiJsonToBinRequest
properties:
binargs:
type: string
pattern: '^(([0-9a-f][0-9a-f])+)?$'
title: Hex
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
binargs:
$ref: '#/paths/~1abi_json_to_bin/post/requestBody/content/application~1json/schema/properties/binargs'
/abi_bin_to_json:
post:
tags:
- Chain
summary: abi_bin_to_json
description: Returns an object containing rows from the specified table.
operationId: abi_bin_to_json
parameters: []
requestBody:
content:
application/json:
schema:
type: object
title: AbiBinToJsonRequest
properties:
code:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
action:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
binargs:
$ref: '#/paths/~1abi_json_to_bin/post/requestBody/content/application~1json/schema/properties/binargs'
responses:
'200':
description: OK
content:
application/json:
schema:
type: string
/get_code:
post:
tags:
- Chain
summary: get_code
description: Returns an object containing rows from the specified table.
operationId: get_code
parameters: []
requestBody:
content:
application/json:
schema:
type: object
required:
- account_name
- code_as_wasm
properties:
account_name:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
code_as_wasm:
type: integer
default: 1
description: This must be 1 (true)
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: GetCodeResponse.yaml
properties:
name:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
code_hash:
type: string
pattern: '^[A-z0-9]{64}$'
title: Sha256
wast:
type: string
wasm:
type: string
abi:
$ref: '#/paths/~1get_abi/post/responses/200/content/application~1json/schema'
/get_raw_abi:
post:
tags:
- Chain
summary: get_raw_abi
description: Returns an object containing rows from the specified table.
operationId: get_raw_abi
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
account_name:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
account_name:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
code_hash:
$ref: '#/paths/~1get_raw_abi/post/responses/200/content/application~1json/schema/properties/abi_hash'
abi_hash:
type: string
pattern: '^[A-z0-9]{64}$'
title: Sha256
abi:
type: string
/push_block:
post:
tags:
- Chain
summary: push_block_request
description: Returns an object containing rows from the specified table.
operationId: push_block_request
parameters: []
requestBody:
content:
application/json:
schema:
type: object
additionalProperties: false
minProperties: 9
required:
- timestamp
- producer
- confirmed
- previous
- transaction_mroot
- action_mroot
- schedule_version
- producer_signature
- header_extensions
properties:
timestamp:
type: string
description: 'Date/time string in the format YYYY-MM-DDTHH:MM:SS.sss'
pattern: '^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}$'
title: DateTimeSeconds
producer:
oneOf:
- type: string
maxLength: 0
title: EmptyString
- $ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
confirmed:
pattern: '^[10]$'
description: '1 if true, 0 if false.'
title: Boolean
previous:
$ref: '#/paths/~1get_code/post/responses/200/content/application~1json/schema/properties/code_hash'
transaction_mroot:
$ref: '#/paths/~1get_code/post/responses/200/content/application~1json/schema/properties/code_hash'
action_mroot:
$ref: '#/paths/~1get_code/post/responses/200/content/application~1json/schema/properties/code_hash'
schedule_version:
$ref: '#/paths/~1push_block/post/requestBody/content/application~1json/schema/properties/block_num'
new_producers:
type: array
description: 'array containing account_names for producers that are new, will only appear in the first block that includes the schedule change'
items:
$ref: '#/paths/~1get_abi/post/requestBody/content/application~1json/schema/properties/account_name'
nullable: true
producer_signature:
$ref: '#/paths/~1push_transaction/post/requestBody/content/application~1json/schema/properties/signatures/items'
id:
$ref: '#/paths/~1get_code/post/responses/200/content/application~1json/schema/properties/code_hash'
block_num:
description: A whole number
anyOf:
- type: string
pattern: ^\d+$
- type: integer
title: WholeNumber
ref_block_prefix:
description: 'The lower 32 bits of id, used to prevent replay attacks'
type: integer
block_extensions:
type: array
items:
type: array
items:
anyOf:
- type: integer
- type: string
title: Extension
header_extensions:
type: array
items:
type: string
transactions:
type: array
description: Array containing transactions included in this block
items:
type: object
additionalProperties: false
minProperties: 4
required:
- status
- cpu_usage_us
- net_usage_words
- trx
properties:
status:
type: string
enum:
- executed
- soft_fail
- hard_fail
- delayed
- expired
description: |
status:
* `executed` - Succeed, no error handler executed
* `soft_fail` - Objectively failed (not executed), error handler executed
* `hard_fail` - Objectively failed and error handler objectively failed thus no state change
* `delayed` - Transaction delayed/deferred/scheduled for future execution
* `expired` - Transaction expired and storage space refuned to user
cpu_usage_us:
type: integer
net_usage_words:
type: integer
trx:
anyOf:
- type: string
- type: object
additionalProperties: false
minProperties: 7
required:
- id
- signatures
- compression
- packed_context_free_data
- context_free_data
- packed_trx
- transaction
properties:
id:
type: string
signatures:
type: array
items:
$ref: '#/paths/~1push_transaction/post/requestBody/content/application~1json/schema/properties/signatures/items'
compression:
type: string
packed_context_free_data:
type: string
context_free_data:
type: array
items:
type: string
packed_trx:
type: string
transaction:
$ref: '#/paths/~1push_transactions/post/requestBody/content/application~1json/schema/items'
title: PackedTransaction
title: TransactionVariant
title: TransactionReceipt
title: Block
responses:
'200':
description: OK
content:
application/json:
schema: {}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment