@openzeppelin/relayer-sdk
Version:
OpenZeppelin Relayer SDK
95 lines (94 loc) • 2.41 kB
TypeScript
/**
* OpenZeppelin Relayer API
* OpenZeppelin Relayer API
*
* The version of the OpenAPI document: 1.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { DisabledReason } from './disabled-reason';
import type { MaskedRpcConfig } from './masked-rpc-config';
import type { RelayerNetworkPolicyResponse } from './relayer-network-policy-response';
import type { RelayerNetworkType } from './relayer-network-type';
/**
* Relayer response model for API endpoints
* @export
* @interface RelayerResponse
*/
export interface RelayerResponse {
/**
*
* @type {string}
* @memberof RelayerResponse
*/
'address'?: string;
/**
* Custom RPC URLs with sensitive path/query parameters masked for security. The domain is visible to identify providers (e.g., Alchemy, Infura) but API keys embedded in paths are hidden.
* @type {Array<MaskedRpcConfig>}
* @memberof RelayerResponse
*/
'custom_rpc_urls'?: Array<MaskedRpcConfig>;
/**
*
* @type {DisabledReason}
* @memberof RelayerResponse
*/
'disabled_reason'?: DisabledReason;
/**
*
* @type {string}
* @memberof RelayerResponse
*/
'id': string;
/**
*
* @type {string}
* @memberof RelayerResponse
*/
'name': string;
/**
*
* @type {string}
* @memberof RelayerResponse
*/
'network': string;
/**
*
* @type {RelayerNetworkType}
* @memberof RelayerResponse
*/
'network_type': RelayerNetworkType;
/**
*
* @type {string}
* @memberof RelayerResponse
*/
'notification_id'?: string;
/**
*
* @type {boolean}
* @memberof RelayerResponse
*/
'paused': boolean;
/**
* Policies without redundant network_type tag - network type is available at top level Only included if user explicitly provided policies (not shown for empty/default policies)
* @type {RelayerNetworkPolicyResponse}
* @memberof RelayerResponse
*/
'policies'?: RelayerNetworkPolicyResponse;
/**
*
* @type {string}
* @memberof RelayerResponse
*/
'signer_id': string;
/**
*
* @type {boolean}
* @memberof RelayerResponse
*/
'system_disabled'?: boolean;
}