Registrar un protocolo
curl --request POST \
--url https://app.blockgence.com/v1/guard/protocols \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"contracts": [
{
"address": "<string>",
"name": ""
}
],
"chain": "ethereum",
"rules": {},
"shared": false,
"events": [
{}
]
}
'import requests
url = "https://app.blockgence.com/v1/guard/protocols"
payload = {
"name": "<string>",
"contracts": [
{
"address": "<string>",
"name": ""
}
],
"chain": "ethereum",
"rules": {},
"shared": False,
"events": [{}]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
contracts: [{address: '<string>', name: ''}],
chain: 'ethereum',
rules: {},
shared: false,
events: [{}]
})
};
fetch('https://app.blockgence.com/v1/guard/protocols', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.blockgence.com/v1/guard/protocols",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'contracts' => [
[
'address' => '<string>',
'name' => ''
]
],
'chain' => 'ethereum',
'rules' => [
],
'shared' => false,
'events' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.blockgence.com/v1/guard/protocols"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"contracts\": [\n {\n \"address\": \"<string>\",\n \"name\": \"\"\n }\n ],\n \"chain\": \"ethereum\",\n \"rules\": {},\n \"shared\": false,\n \"events\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.blockgence.com/v1/guard/protocols")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"contracts\": [\n {\n \"address\": \"<string>\",\n \"name\": \"\"\n }\n ],\n \"chain\": \"ethereum\",\n \"rules\": {},\n \"shared\": false,\n \"events\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.blockgence.com/v1/guard/protocols")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"contracts\": [\n {\n \"address\": \"<string>\",\n \"name\": \"\"\n }\n ],\n \"chain\": \"ethereum\",\n \"rules\": {},\n \"shared\": false,\n \"events\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"detail": "<string>",
"error": "<string>"
}{
"detail": "<string>",
"error": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>",
"error": "<string>"
}Guard
Registrar un protocolo
Registra un protocolo y sus contratos en Watchtower. Cada contrato es una vigilancia de Guard con
purpose: "protocol" y las reglas del protocolo.
Cuerpo del pedido: {"name": "…", "chain": "ethereum", "contracts": [{"address": "0x…", "name": "…"}], "rules": {…}, "shared": false, "events": [...]}.
contracts: de 1 a 50. Cuentan contra el límite de vigilancias del plan. Se registran todos o ninguno.chain: solo las redes listadas enwatchtower.chainsdeGET /v1/guard/status.rules: se combinan con las reglas por defecto (presets.protocolenGET /v1/guard/status):large_withdrawal: lo que sale del contrato en una transacción, neto de lo que entra en la misma transacción, en USD y solo con activos con precio. Umbralmin_usd, por defecto US$1,000,000. Un préstamo flash que se devuelve o un swap en un pool no lo alcanzan.authority_change: cambio de propietario (owner) o de administrador (admin), y otorgar, quitar o cambiar el rol de administración. Conall_roles: 1, cualquier rol.authority_transfer_started: la propuesta de un propietario o un administrador nuevo en un traspaso en dos pasos de OpenZeppelin, antes de que se acepte.proxy_upgrade: upgrade del proxy o del beacon.pause: pausa y reanudación.scheduled_change: una llamada programada en un timelock o una propuesta de un governor registrados como contratos del protocolo. Avisa antes de la ejecución, con el efecto de la llamada simulado sobre el estado del bloque en que se programó. Ese estado puede cambiar antes de la ejecución, y un revert en la simulación no significa que la ejecución vaya a fallar.protocol_event: los eventos propios declarados enevents.events: opcional, eventos propios a vigilar. Cada uno es{"signature": "Evento(address indexed a, bool b)", "label": "…", "severity": "high", "contracts": ["0x…"]}.severityeshighpor defecto, ycontractsvacío aplica a todos los contratos del protocolo. Para elegirlo del ABI verificado, agregue"source": "abi", "abi_address": "0x…"(verGET /v1/guard/protocols/{pid}/abi-events). Hasta 30 eventos, firmas de hasta 300 caracteres y hasta 3 parámetros indexados. No se aceptan eventos anónimos, repetidos, de contratos ajenos al protocolo ni los que Guard ya lee (los de autoridad,Transfer,Approval,ApprovalForAll,TransferSingle,TransferBatch,CallScheduled,QueueTransactionyProposalCreated).
Las alertas de autoridad y las de cambios programados de severidad alta o crítica no se pierden por el tope diario de alertas. Las de eventos propios tienen un tope propio de 50 por contrato y por día. De un contrato se guardan sus eventos de autoridad y los de las transacciones con alerta, no cada transferencia.
Responde el protocolo creado, con la misma forma que GET /v1/guard/protocols/{pid}.
Errores:
400: red no disponible para Watchtower, nombre vacío, cantidad de contratos fuera de 1 a 50, dirección inválida o repetida, regla inválida,sharedsin organización, o un evento inválido (incluido un contrato sin código verificado o una firma que no está en su ABI).403: los contratos superan el límite de vigilancias del plan, o la clave de API no está asignada a una persona.404: Watchtower no está habilitado.409: uno de los contratos ya está vigilado.422: el cuerpo del pedido trae un campo desconocido.502: no se pudo leer el ABI verificado que necesita un evento;detail.failuredescribe la falla.
Costo: sin cargo.
POST
/
v1
/
guard
/
protocols
Registrar un protocolo
curl --request POST \
--url https://app.blockgence.com/v1/guard/protocols \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"contracts": [
{
"address": "<string>",
"name": ""
}
],
"chain": "ethereum",
"rules": {},
"shared": false,
"events": [
{}
]
}
'import requests
url = "https://app.blockgence.com/v1/guard/protocols"
payload = {
"name": "<string>",
"contracts": [
{
"address": "<string>",
"name": ""
}
],
"chain": "ethereum",
"rules": {},
"shared": False,
"events": [{}]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
contracts: [{address: '<string>', name: ''}],
chain: 'ethereum',
rules: {},
shared: false,
events: [{}]
})
};
fetch('https://app.blockgence.com/v1/guard/protocols', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.blockgence.com/v1/guard/protocols",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'contracts' => [
[
'address' => '<string>',
'name' => ''
]
],
'chain' => 'ethereum',
'rules' => [
],
'shared' => false,
'events' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.blockgence.com/v1/guard/protocols"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"contracts\": [\n {\n \"address\": \"<string>\",\n \"name\": \"\"\n }\n ],\n \"chain\": \"ethereum\",\n \"rules\": {},\n \"shared\": false,\n \"events\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.blockgence.com/v1/guard/protocols")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"contracts\": [\n {\n \"address\": \"<string>\",\n \"name\": \"\"\n }\n ],\n \"chain\": \"ethereum\",\n \"rules\": {},\n \"shared\": false,\n \"events\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.blockgence.com/v1/guard/protocols")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"contracts\": [\n {\n \"address\": \"<string>\",\n \"name\": \"\"\n }\n ],\n \"chain\": \"ethereum\",\n \"rules\": {},\n \"shared\": false,\n \"events\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"detail": "<string>",
"error": "<string>"
}{
"detail": "<string>",
"error": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>",
"error": "<string>"
}Autorizaciones
APIKeyHeaderBearerAuth
Encabezados
Cuerpo
application/json
Respuesta
Respuesta correcta.