@openzeppelin/defender-as-code
Version:
Configure your Defender environment via code
1,202 lines • 34.1 kB
TypeScript
export declare const DefenderSchema: {
$id: string;
$schema: string;
title: string;
type: string;
properties: {
key: {
type: string;
};
secret: {
type: string;
};
};
required: string[];
};
export declare const DefinitionsSchema: {
$id: string;
$schema: string;
title: string;
definitions: {
"defender-id": {
title: string;
type: string;
pattern: string;
};
address: {
title: string;
type: string;
pattern: string;
};
"risk-category": {
title: string;
type: string;
enum: string[];
};
"public-network": {
title: string;
type: string;
enum: string[];
};
"custom-network": {
title: string;
type: string;
enum: string[];
};
"tenant-network": {
title: string;
type: string;
};
network: {
title: string;
anyOf: {
$ref: string;
}[];
};
"supported-network": {
title: string;
oneOf: {
$ref: string;
}[];
};
flashbotTransactionMode: {
title: string;
type: string;
description: string;
enum: string[];
};
privateTransactionMode: {
title: string;
oneOf: {
$ref: string;
}[];
};
policy: {
title: string;
type: string;
properties: {
"gas-price-cap": {
type: string;
};
"whitelist-receivers": {
title: string;
type: string;
items: {
type: string;
};
};
"eip1559-pricing": {
type: string;
};
"private-transactions": {
oneOf: ({
description: string;
type: string;
$ref?: undefined;
} | {
$ref: string;
description?: undefined;
type?: undefined;
})[];
};
};
};
relayer: {
title: string;
type: string;
properties: {
name: {
type: string;
};
network: {
$ref: string;
format: string;
};
"min-balance": {
type: string;
};
"address-from-relayer": {
title: string;
anyOf: {
type: string;
}[];
};
policy: {
$ref: string;
format: string;
};
"api-keys": {
title: string;
type: string;
items: {
type: string;
};
};
"relayer-group-id": {
$ref: string;
format: string;
};
"notification-channels": {
$ref: string;
format: string;
};
};
required: string[];
};
"notification-channels": {
title: string;
type: string;
properties: {
events: {
title: string;
type: string;
items: {
type: string;
enum: string[];
};
};
"notification-ids": {
title: string;
type: string;
items: {
$ref: string;
format: string;
};
};
};
required: string[];
};
"relayer-group-relayer": {
title: string;
type: string;
properties: {
"relayer-id": {
$ref: string;
format: string;
};
address: {
$ref: string;
format: string;
};
"key-id": {
type: string;
};
balance: {
type: string;
};
};
required: string[];
};
"relayer-group": {
title: string;
type: string;
properties: {
name: {
type: string;
};
network: {
$ref: string;
format: string;
};
"min-balance": {
type: string;
};
relayers: {
type: string;
};
policy: {
$ref: string;
format: string;
};
"user-weight-caps": {
title: string;
type: string;
additionalProperties: {
type: string;
};
};
"notification-channels": {
$ref: string;
format: string;
};
"api-keys": {
title: string;
type: string;
items: {
type: string;
};
};
};
required: string[];
};
contract: {
title: string;
type: string;
properties: {
name: {
type: string;
};
address: {
$ref: string;
format: string;
};
network: {
$ref: string;
format: string;
};
abi: {
$ref: string;
};
"nat-spec": {
type: string;
};
};
required: string[];
};
notificationType: {
title: string;
type: string;
enum: string[];
};
datadogConfig: {
title: string;
type: string;
properties: {
"api-key": {
type: string;
};
"metric-prefix": {
type: string;
maxLength: number;
pattern: string;
};
};
required: string[];
};
urlConfig: {
title: string;
type: string;
properties: {
url: {
type: string;
format: string;
};
};
required: string[];
};
telegramBotConfig: {
title: string;
type: string;
properties: {
"bot-token": {
type: string;
};
"chat-id": {
type: string;
};
};
required: string[];
};
emailConfig: {
title: string;
type: string;
properties: {
emails: {
title: string;
type: string;
items: {
type: string;
format: string;
};
default: never[];
};
};
required: string[];
};
opsgenieUserType: {
title: string;
type: string;
enum: string[];
};
opsgeniePriorityLevel: {
title: string;
type: string;
enum: string[];
};
opsgenieInstanceLocation: {
title: string;
type: string;
enum: string[];
};
opsgenieUser: {
title: string;
type: string;
properties: {
username: {
type: string;
};
fullName: {
type: string;
};
id: {
type: string;
};
type: {
$ref: string;
};
};
required: string[];
additionalProperties: boolean;
};
opsgenieConfig: {
title: string;
properties: {
apiKey: {
type: string;
};
instanceLocation: {
$ref: string;
};
alias: {
type: string;
maxLength: number;
};
responders: {
title: string;
type: string;
items: {
$ref: string;
};
};
visibleTo: {
title: string;
type: string;
items: {
$ref: string;
};
};
actions: {
title: string;
type: string;
maxItems: number;
items: {
type: string;
maxLength: number;
};
};
tags: {
title: string;
type: string;
maxItems: number;
items: {
type: string;
maxLength: number;
};
};
details: {
title: string;
type: string;
additionalProperties: {
type: string;
};
};
entity: {
type: string;
maxLength: number;
};
priority: {
$ref: string;
};
note: {
type: string;
maxLength: number;
};
};
required: string[];
additionalProperties: boolean;
};
pagerDutyEventType: {
title: string;
type: string;
enum: string[];
};
pagerDutyEventAction: {
title: string;
type: string;
enum: string[];
};
pagerDutySeverity: {
title: string;
type: string;
enum: string[];
};
pagerDutyConfig: {
title: string;
properties: {
token: {
type: string;
};
eventType: {
$ref: string;
};
routingKey: {
type: string;
maxLength: number;
minLength: number;
};
eventAction: {
$ref: string;
};
dedupKey: {
type: string;
maxLength: number;
};
severity: {
$ref: string;
};
component: {
type: string;
};
group: {
type: string;
};
class: {
type: string;
};
customDetails: {
title: string;
type: string;
additionalProperties: {
type: string;
};
};
};
if: {
properties: {
eventType: {
const: string;
};
};
};
then: {
required: string[];
};
required: string[];
additionalProperties: boolean;
};
notification: {
title: string;
type: string;
properties: {
type: {
$ref: string;
format: string;
};
name: {
type: string;
};
paused: {
type: string;
};
config: {
title: string;
type: string;
oneOf: {
$ref: string;
format: string;
}[];
};
};
required: string[];
};
"block-monitor": {
title: string;
type: string;
properties: {
name: {
type: string;
};
type: {
type: string;
enum: string[];
};
network: {
$ref: string;
format: string;
};
contracts: {
title: string;
type: string;
items: {
$ref: string;
format: string;
};
};
addresses: {
title: string;
type: string;
items: {
$ref: string;
format: string;
};
};
abi: {
$ref: string;
};
"alert-threshold": {
title: string;
type: string;
properties: {
amount: {
type: string;
};
"window-seconds": {
type: string;
};
};
required: string[];
};
paused: {
type: string;
};
"skip-abi-validation": {
type: string;
description: string;
};
"action-condition": {
$ref: string;
format: string;
};
"action-trigger": {
$ref: string;
format: string;
};
"confirm-level": {
oneOf: ({
type: string;
enum: string[];
} | {
type: string;
enum?: undefined;
})[];
};
"notify-config": {
title: string;
type: string;
properties: {
timeout: {
type: string;
};
message: {
type: string;
};
"message-subject": {
type: string;
};
"severity-level": {
type: string;
enum: string[];
};
channels: {
title: string;
type: string;
items: {
$ref: string;
format: string;
};
};
};
required: string[];
};
conditions: {
title: string;
type: string;
properties: {
event: {
title: string;
type: string;
items: {
title: string;
type: string;
properties: {
signature: {
type: string;
};
expression: {
type: string;
};
};
required: string[];
};
};
function: {
title: string;
type: string;
items: {
title: string;
type: string;
properties: {
signature: {
type: string;
};
expression: {
type: string;
};
};
required: string[];
};
};
transaction: {
type: string;
};
};
};
"risk-category": {
$ref: string;
};
};
required: string[];
};
"forta-monitor": {
title: string;
type: string;
properties: {
name: {
type: string;
};
type: {
type: string;
enum: string[];
};
network: {
$ref: string;
format: string;
};
contracts: {
title: string;
type: string;
items: {
$ref: string;
format: string;
};
};
addresses: {
title: string;
type: string;
items: {
$ref: string;
format: string;
};
};
abi: {
$ref: string;
};
"alert-threshold": {
title: string;
type: string;
properties: {
amount: {
type: string;
};
"window-seconds": {
type: string;
};
};
};
paused: {
type: string;
};
"action-condition": {
$ref: string;
format: string;
};
"action-trigger": {
$ref: string;
format: string;
};
"notify-config": {
title: string;
type: string;
properties: {
timeout: {
type: string;
};
message: {
type: string;
};
"message-subject": {
type: string;
};
severityLevel: {
type: string;
enum: string[];
};
channels: {
title: string;
type: string;
items: {
$ref: string;
format: string;
};
};
};
required: string[];
};
conditions: {
title: string;
type: string;
properties: {
"min-scanner-count": {
type: string;
};
severity: {
type: string;
enum: number[];
};
"alert-ids": {
title: string;
type: string;
items: {
type: string;
};
};
};
required: string[];
};
"forta-node-id": {
type: string;
};
"forta-last-processed-time": {
type: string;
};
"agent-ids": {
title: string;
type: string;
items: {
type: string;
};
};
"risk-category": {
$ref: string;
};
};
required: string[];
dependencies: {
addresses: string[];
network: string[];
};
};
monitor: {
title: string;
type: string;
oneOf: {
$ref: string;
format: string;
}[];
};
"relayer-or-defender-id": {
title: string;
anyOf: {
type: string;
$ref: string;
format: string;
}[];
};
"relayer-group-or-defender-id": {
title: string;
anyOf: {
type: string;
$ref: string;
format: string;
}[];
};
"action-or-defender-id": {
title: string;
anyOf: {
type: string;
$ref: string;
format: string;
}[];
};
"monitor-or-defender-id": {
title: string;
anyOf: {
type: string;
$ref: string;
format: string;
}[];
};
"forked-network-or-defender-id": {
title: string;
anyOf: {
type: string;
$ref: string;
format: string;
}[];
};
"private-network-or-defender-id": {
title: string;
anyOf: {
type: string;
$ref: string;
format: string;
}[];
};
"block-explorer-api-key-or-defender-id": {
title: string;
anyOf: {
type: string;
$ref: string;
format: string;
}[];
};
"notification-or-defender-id": {
title: string;
anyOf: {
type: string;
$ref: string;
format: string;
}[];
};
"contract-or-defender-id": {
title: string;
anyOf: ({
type: string;
$ref: string;
format: string;
title?: undefined;
pattern?: undefined;
} | {
title: string;
type: string;
pattern: string;
$ref?: undefined;
format?: undefined;
})[];
};
"policy-or-defender-id": {
title: string;
anyOf: {
type: string;
$ref: string;
format: string;
}[];
};
action: {
title: string;
type: string;
properties: {
name: {
type: string;
};
path: {
type: string;
};
relayer: {
$ref: string;
format: string;
};
trigger: {
title: string;
type: string;
properties: {
type: {
title: string;
type: string;
enum: string[];
};
cron: {
title: string;
type: string;
};
frequency: {
title: string;
type: string;
};
};
if: {
properties: {
type: {
const: string;
};
};
};
then: {
oneOf: {
required: string[];
}[];
};
else: {};
required: string[];
};
paused: {
type: string;
};
"environment-variables": {
type: string;
additionalProperties: {
type: string;
};
};
};
required: string[];
};
"block-explorer-api-key": {
title: string;
type: string;
properties: {
key: {
type: string;
};
network: {
$ref: string;
format: string;
};
};
required: string[];
};
abi: {
title: string;
anyOf: {
title: string;
type: string;
}[];
};
"safe-contracts": {
title: string;
type: string;
additionalProperties: boolean;
required: string[];
properties: {
master: {
$ref: string;
format: string;
};
"proxy-factory": {
$ref: string;
format: string;
};
"multi-send-call-only": {
$ref: string;
format: string;
};
"create-call": {
$ref: string;
format: string;
};
};
};
"tenant-network-eip-configuration": {
title: string;
type: string;
additionalProperties: boolean;
properties: {
isEIP1559: {
type: string;
};
};
};
"tenant-network-configuration": {
title: string;
type: string;
additionalProperties: boolean;
required: string[];
properties: {
symbol: {
type: string;
minLength: number;
maxLength: number;
};
eips: {
$ref: string;
};
"safe-contracts": {
$ref: string;
};
"subgraph-url": {
type: string;
pattern: string;
};
};
};
"forked-network-request": {
title: string;
type: string;
additionalProperties: boolean;
required: string[];
properties: {
name: {
$ref: string;
};
"supported-network": {
$ref: string;
};
"rpc-url": {
type: string;
pattern: string;
};
"api-key": {
type: string;
};
"block-explorer-url": {
type: string;
pattern: string;
};
};
};
"private-network-request": {
title: string;
type: string;
additionalProperties: boolean;
required: string[];
properties: {
name: {
$ref: string;
};
configuration: {
$ref: string;
};
"rpc-url": {
type: string;
pattern: string;
};
"api-key": {
type: string;
};
"block-explorer-url": {
type: string;
pattern: string;
};
};
};
};
};
export declare const ProviderSchema: {
$id: string;
$schema: string;
title: string;
type: string;
properties: {
stage: {
type: string;
};
stackName: {
type: string;
};
ssot: {
type: string;
};
};
required: string[];
};
export declare const ResourcesSchema: {
$id: string;
$schema: string;
title: string;
type: string;
additionalProperties: boolean;
properties: {
actions: {
title: string;
type: string;
additionalProperties: {
$ref: string;
format: string;
};
};
notifications: {
title: string;
type: string;
additionalProperties: {
$ref: string;
format: string;
};
};
relayers: {
title: string;
type: string;
additionalProperties: {
$ref: string;
format: string;
};
};
"relayer-groups": {
title: string;
type: string;
additionalProperties: {
$ref: string;
format: string;
};
};
policies: {
title: string;
type: string;
additionalProperties: {
$ref: string;
format: string;
};
};
contracts: {
title: string;
type: string;
additionalProperties: {
$ref: string;
format: string;
};
};
secrets: {
title: string;
type: string;
additionalProperties: boolean;
properties: {
global: {
title: string;
type: string;
additionalProperties: {
type: string;
};
};
stack: {
title: string;
type: string;
additionalProperties: {
type: string;
};
};
};
};
monitors: {
title: string;
type: string;
additionalProperties: {
$ref: string;
format: string;
};
};
"block-explorer-api-keys": {
title: string;
type: string;
additionalProperties: {
$ref: string;
format: string;
};
};
"forked-networks": {
title: string;
type: string;
additionalProperties: {
$ref: string;
format: string;
};
};
"private-networks": {
title: string;
type: string;
additionalProperties: {
$ref: string;
format: string;
};
};
};
};
//# sourceMappingURL=index.d.ts.map