description:Endpoints used by the nodes running in coordinator mode. They are used to interact with the network.
- name:Explorer
description:Endpoints used by the nodes running in explorer mode. They are used to get information of the netwrok.
paths:
paths:
'/account-creation-authorization':
'/account-creation-authorization':
post:
post:
tags:
tags:
- Account
- Coordinator
summary:Send an authorization that will allow the coordinator to register accounts associated to an Ethereum address on behalf of the user.
summary:Send an authorization that will allow the coordinator to register accounts associated to an Ethereum address on behalf of the user.
description:>-
description:>-
Send an authorization to create rollup accounts associated with an Ethereum address. Each account creation (an account can only hold a specific token) is effective once the coordinator forges the corresponding L1CoordinatorTx (which is always of type *account creation*).
Send an authorization to create rollup accounts associated with an Ethereum address. Each account creation (an account can only hold a specific token) is effective once the coordinator forges the corresponding L1CoordinatorTx (which is always of type *account creation*).
summary:Find out if the coordinator has the ability to create accounts associated with an Ethereum address.
summary:Find out if the coordinator has the ability to create accounts associated with an Ethereum address.
description:>-
description:>-
Returns the authorization to perform an account creation with the given Ethereum address on behalf of the Ethereum address holder.
Returns the authorization to perform an account creation with the given Ethereum address on behalf of the Ethereum address holder.
@ -153,7 +142,7 @@ paths:
'/accounts':
'/accounts':
get:
get:
tags:
tags:
- Account
- Explorer
summary:Get accounts balances and other associated information.
summary:Get accounts balances and other associated information.
description:Get account balances and other associated information.
description:Get account balances and other associated information.
operationId:getAccounts
operationId:getAccounts
@ -166,7 +155,7 @@ paths:
$ref:'#/components/schemas/HezEthereumAddress'
$ref:'#/components/schemas/HezEthereumAddress'
- name:BJJ
- name:BJJ
in:query
in:query
description:Only get accounts associated to a BabyJubJub public key. Incompatible with the query `hezEthereumAddress`.
description:Only get accounts associated to a BabyJubJub compressed public key. Incompatible with the query `hezEthereumAddress`.
required:false
required:false
schema:
schema:
$ref:'#/components/schemas/BJJ'
$ref:'#/components/schemas/BJJ'
@ -224,7 +213,7 @@ paths:
'/accounts/{accountIndex}':
'/accounts/{accountIndex}':
get:
get:
tags:
tags:
- Account
- Explorer
summary:Get an account by its index.
summary:Get an account by its index.
description:Get an account by its index.
description:Get an account by its index.
operationId:getAccount
operationId:getAccount
@ -263,7 +252,7 @@ paths:
'/exits':
'/exits':
get:
get:
tags:
tags:
- Account
- Explorer
summary:Get exit information. This information is required to perform a withdraw.
summary:Get exit information. This information is required to perform a withdraw.
description:Get exit information. This information is required to perform a withdraw.
description:Get exit information. This information is required to perform a withdraw.
operationId:getExits
operationId:getExits
@ -282,7 +271,7 @@ paths:
$ref:'#/components/schemas/HezEthereumAddress'
$ref:'#/components/schemas/HezEthereumAddress'
- name:BJJ
- name:BJJ
in:query
in:query
description:Get exits associated to a BabyJubJub public key. Incompatible with query `hezEthereumAddress` and `accountIndex`.
description:Get exits associated to a BabyJubJub compressed public key. Incompatible with query `hezEthereumAddress` and `accountIndex`.
required:false
required:false
schema:
schema:
$ref:'#/components/schemas/BJJ'
$ref:'#/components/schemas/BJJ'
@ -350,7 +339,7 @@ paths:
'/exits/{batchNum}/{accountIndex}':
'/exits/{batchNum}/{accountIndex}':
get:
get:
tags:
tags:
- Account
- Explorer
summary:Get specific exit information.
summary:Get specific exit information.
description:Get exit information form a specific exit tree and account. This information is required to perform a withdraw. Exits are identified with accounIndex and batchNum since every batch that has exits has a different exit tree.
description:Get exit information form a specific exit tree and account. This information is required to perform a withdraw. Exits are identified with accounIndex and batchNum since every batch that has exits has a different exit tree.
operationId:getExit
operationId:getExit
@ -395,7 +384,7 @@ paths:
'/transactions-pool':
'/transactions-pool':
post:
post:
tags:
tags:
- Transaction
- Coordinator
summary:Add an L2 transaction to the coordinator's pool.
summary:Add an L2 transaction to the coordinator's pool.
description:>-
description:>-
Send L2 transaction. The transaction will be stored in the transaction pool of the coordinator and eventually forged.
Send L2 transaction. The transaction will be stored in the transaction pool of the coordinator and eventually forged.
@ -429,7 +418,7 @@ paths:
'/transactions-pool/{id}':
'/transactions-pool/{id}':
get:
get:
tags:
tags:
- Transaction
- Coordinator
summary:Get details and status of a transaction that is in the pool.
summary:Get details and status of a transaction that is in the pool.
description:>-
description:>-
Get transaction from the pool by its ID. This endpoint is specially useful for tracking the status of a transaction that may not be forged yet.
Get transaction from the pool by its ID. This endpoint is specially useful for tracking the status of a transaction that may not be forged yet.
@ -472,7 +461,7 @@ paths:
'/transactions-history':
'/transactions-history':
get:
get:
tags:
tags:
- Transaction
- Explorer
summary:Get details and status of transactions that have been forged.
summary:Get details and status of transactions that have been forged.
description:>-
description:>-
Get historical transactions. This endpoint will return all the different types of **forged** transactions, this means that:
Get historical transactions. This endpoint will return all the different types of **forged** transactions, this means that:
@ -494,7 +483,7 @@ paths:
$ref:'#/components/schemas/HezEthereumAddress'
$ref:'#/components/schemas/HezEthereumAddress'
- name:BJJ
- name:BJJ
in:query
in:query
description:Only get transactions associated with a BabyJubJub public key. Incompatible with the queries `hezEthereumAddress` and `accountIndex`.
description:Only get transactions associated with a BabyJubJub compressed public key. Incompatible with the queries `hezEthereumAddress` and `accountIndex`.
required:false
required:false
schema:
schema:
$ref:'#/components/schemas/BJJ'
$ref:'#/components/schemas/BJJ'
@ -562,7 +551,7 @@ paths:
'/transactions-history/{id}':
'/transactions-history/{id}':
get:
get:
tags:
tags:
- Transaction
- Explorer
summary:Get details and status of a historical transaction.
summary:Get details and status of a historical transaction.
description:>-
description:>-
Get transaction by its ID. This endpoint will return all the different types of transactions except those that are still in the pool of any coordinator.
Get transaction by its ID. This endpoint will return all the different types of transactions except those that are still in the pool of any coordinator.
@ -602,7 +591,7 @@ paths:
'/batches':
'/batches':
get:
get:
tags:
tags:
- Hermez status
- Explorer
summary:Get information about forged batches.
summary:Get information about forged batches.
description:>-
description:>-
Get information about forged batches.
Get information about forged batches.
@ -678,7 +667,7 @@ paths:
'/batches/{batchNum}':
'/batches/{batchNum}':
get:
get:
tags:
tags:
- Hermez status
- Explorer
summary:Get a specific batch.
summary:Get a specific batch.
description:>-
description:>-
Get a specific batch.
Get a specific batch.
@ -718,7 +707,7 @@ paths:
'/full-batches/{batchNum}':
'/full-batches/{batchNum}':
get:
get:
tags:
tags:
- Hermez status
- Explorer
summary:Get a full batch.
summary:Get a full batch.
description:>-
description:>-
Get a specific batch, including the associated transactions. The object returned in this method can be a bit heavy.
Get a specific batch, including the associated transactions. The object returned in this method can be a bit heavy.
@ -759,7 +748,7 @@ paths:
'/slots':
'/slots':
get:
get:
tags:
tags:
- Hermez status
- Explorer
summary:Get information about slots.
summary:Get information about slots.
description:>-
description:>-
Get information about slots.
Get information about slots.
@ -835,7 +824,7 @@ paths:
'/slots/{slotNum}':
'/slots/{slotNum}':
get:
get:
tags:
tags:
- Hermez status
- Explorer
summary:Get information about a specific slot.
summary:Get information about a specific slot.
description:>-
description:>-
Get information about a specific slot.
Get information about a specific slot.
@ -875,7 +864,7 @@ paths:
'/bids':
'/bids':
get:
get:
tags:
tags:
- Hermez status
- Explorer
summary:Get a list of bids.
summary:Get a list of bids.
description:>-
description:>-
Get a list of bids. It's necessary to provide at least one of the following filters:`slotNum`, `bidderAddr`.
Get a list of bids. It's necessary to provide at least one of the following filters:`slotNum`, `bidderAddr`.
@ -939,7 +928,7 @@ paths:
'/state':
'/state':
get:
get:
tags:
tags:
- Hermez status
- Explorer
summary:Return information that represents the current state of the network.
summary:Return information that represents the current state of the network.
description:Return information that represents the current state of the network. It also includes metrics and statistics.
description:Return information that represents the current state of the network. It also includes metrics and statistics.
operationId:getState
operationId:getState
@ -965,7 +954,7 @@ paths:
'/config':
'/config':
get:
get:
tags:
tags:
- Hermez status
- Explorer
summary:Return constant configuration of the network.
summary:Return constant configuration of the network.
description:Return constant configuration of the network.
description:Return constant configuration of the network.
operationId:getConfig
operationId:getConfig
@ -985,7 +974,7 @@ paths:
'/tokens':
'/tokens':
get:
get:
tags:
tags:
- Hermez status
- Explorer
summary:Get information of the supported tokens in the Hermez Network.
summary:Get information of the supported tokens in the Hermez Network.
description:Get information of the supported tokens in the Hermez Network.
description:Get information of the supported tokens in the Hermez Network.
operationId:getTokens
operationId:getTokens
@ -1058,7 +1047,7 @@ paths:
'/tokens/{id}':
'/tokens/{id}':
get:
get:
tags:
tags:
- Hermez status
- Explorer
summary:Get information of a token supported by Hermez Network.
summary:Get information of a token supported by Hermez Network.
description:Get information of a token supported by Hermez Network.
description:Get information of a token supported by Hermez Network.
operationId:getToken
operationId:getToken
@ -1097,7 +1086,7 @@ paths:
'/coordinators':
'/coordinators':
get:
get:
tags:
tags:
- Hermez status
- Explorer
summary:Get information about coordinators.
summary:Get information about coordinators.
description:Get information about coordinators.
description:Get information about coordinators.
operationId:getCoordinators
operationId:getCoordinators
@ -1191,7 +1180,7 @@ components:
toBjj:
toBjj:
type:string
type:string
description:>-
description:>-
BabyJubJub public key, encoded as base64 URL (RFC 4648), which result in 33 bytes. The padding byte is replaced by a sum of the encoded bytes.
BabyJubJub compressed public key, encoded as base64 URL (RFC 4648), which result in 33 bytes. The padding byte is replaced by a sum of the encoded bytes.
If this is provided, toAccountIndex must be null and toHezEthereumAddress must be hez:0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF.
If this is provided, toAccountIndex must be null and toHezEthereumAddress must be hez:0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF.
pattern:"^hez:[A-Za-z0-9_-]{44}$"
pattern:"^hez:[A-Za-z0-9_-]{44}$"
example:null
example:null
@ -1291,7 +1280,7 @@ components:
nullable:true
nullable:true
fromBJJ:
fromBJJ:
type:string
type:string
description:"BabyJubJub public key, encoded as base64 URL (RFC 4648), which result in 33 bytes. The padding byte is replaced by a sum of the encoded bytes."
description:"BabyJubJub compressed public key, encoded as base64 URL (RFC 4648), which result in 33 bytes. The padding byte is replaced by a sum of the encoded bytes."
description:"BabyJubJub public key, encoded as base64 URL (RFC 4648), which result in 33 bytes. The padding byte is replaced by a sum of the encoded bytes."
description:"BabyJubJub compressed public key, encoded as base64 URL (RFC 4648), which result in 33 bytes. The padding byte is replaced by a sum of the encoded bytes."
pattern:"^hez:[A-Za-z0-9_-]{44}$"
pattern:"^hez:[A-Za-z0-9_-]{44}$"
example:null
example:null
nullable:true
nullable:true
@ -1363,7 +1352,7 @@ components:
example:null
example:null
requestToBJJ:
requestToBJJ:
type:string
type:string
description:"BabyJubJub public key, encoded as base64 URL (RFC 4648), which result in 33 bytes. The padding byte is replaced by a sum of the encoded bytes."
description:"BabyJubJub compressed public key, encoded as base64 URL (RFC 4648), which result in 33 bytes. The padding byte is replaced by a sum of the encoded bytes."
description:"BabyJubJub public key, encoded as base64 URL (RFC 4648), which result in 33 bytes. The padding byte is replaced by a sum of the encoded bytes."
description:"BabyJubJub compressed public key, encoded as base64 URL (RFC 4648), which result in 33 bytes. The padding byte is replaced by a sum of the encoded bytes."
description:"BabyJubJub public key, encoded as base64 URL (RFC 4648), which result in 33 bytes. The padding byte is replaced by a sum of the encoded bytes."
description:"BabyJubJub compressed public key, encoded as base64 URL (RFC 4648), which result in 33 bytes. The padding byte is replaced by a sum of the encoded bytes."
description:"BabyJubJub public key, encoded as base64 URL (RFC 4648), which result in 33 bytes. The padding byte is replaced by a sum of the encoded bytes."
description:"BabyJubJub compressed public key, encoded as base64 URL (RFC 4648), which result in 33 bytes. The padding byte is replaced by a sum of the encoded bytes."
description:Block in which the exit balance was instantly withdrawn. Null indicates that an instant withdrawn hasn't been performed.
description:Block in which the exit balance was instantly withdrawn. Null indicates that an instant withdrawn hasn't been performed.
minimum:0
minimum:0
@ -2332,7 +2321,7 @@ components:
maximum:1.84467440737096e+19
maximum:1.84467440737096e+19
example:null
example:null
nullable:true
nullable:true
delayedWithdrawn:
delayedWithdraw:
type:integer
type:integer
description:Block in which the exit balance was delayed withdrawn after a delay withdraw request. Null indicates that a delay withdraw hasn't been performed.
description:Block in which the exit balance was delayed withdrawn after a delay withdraw request. Null indicates that a delay withdraw hasn't been performed.
Eduard S
3 years ago
GitHub