client

package

Go to main page

Versions in this module

v0

v0.1.12

Mar 4, 2026

v0.1.11

Mar 4, 2026

v0.1.8

Mar 4, 2026

v0.1.6

Mar 3, 2026

v0.1.5

Mar 3, 2026

v0.1.4

Mar 3, 2026

v0.1.3

Mar 3, 2026

v0.1.2

Mar 3, 2026

v0.1.1

Mar 3, 2026

v0.1.0

Mar 3, 2026

Changes in this version

type Client

+ Audit *audit.Service

+ EVM *evm.Service

+ Templates *templates.Service

v0.0.2

Feb 24, 2026

Changes in this version

type Client

+ func (c *Client) Metrics(ctx context.Context) (string, error)

type ClientInterface

+ Metrics func(ctx context.Context) (string, error)

type MockClient

+ MetricsFunc func(ctx context.Context) (string, error)

+ func (m *MockClient) Metrics(ctx context.Context) (string, error)

type RequestStatus

+ Payload json.RawMessage

v0.0.1

Feb 24, 2026

Changes in this version

+ const SignTypeEIP191

+ const SignTypeHash

+ const SignTypePersonal

+ const SignTypeRawMessage

+ const SignTypeTransaction

+ const SignTypeTypedData

+ const StatusAuthorizing

+ const StatusCompleted

+ const StatusFailed

+ const StatusPending

+ const StatusRejected

+ const StatusSigning

+ var ErrBlocked = errors.New("request blocked by rule")

+ var ErrInvalidPayload = errors.New("invalid payload")

+ var ErrNotFound = errors.New("not found")

+ var ErrPendingApproval = errors.New("pending manual approval")

+ var ErrRateLimited = errors.New("rate limited")

+ var ErrRejected = errors.New("request rejected")

+ var ErrSignerNotFound = errors.New("signer not found")

+ var ErrTimeout = errors.New("timeout waiting for approval")

+ var ErrUnauthorized = errors.New("unauthorized: invalid or expired API key/signature")

+ type APIError struct

+ Code string

+ Message string

+ StatusCode int

+ func (e *APIError) Error() string

+ func (e *APIError) Is(target error) bool

+ type ApproveRequest struct

+ Approved bool

+ MaxValue string

+ RuleMode string

+ RuleName string

+ RuleType string

+ type ApproveResponse struct

+ GeneratedRule *Rule

+ Message string

+ RequestID string

+ Signature string

+ SignedData string

+ Status string

+ type AuditRecord struct

+ APIKeyID string

+ ActorAddress string

+ ChainID *string

+ ChainType *string

+ Details RuleConfig

+ ErrorMessage string

+ EventType string

+ ID string

+ RequestMethod string

+ RequestPath string

+ RuleID *string

+ Severity string

+ SignRequestID *string

+ SignerAddress *string

+ Timestamp time.Time

+ type BudgetConfig struct

+ AlertPct int

+ MaxPerTx string

+ MaxTotal string

+ MaxTxCount int

+ type Client struct

+ PollInterval time.Duration

+ PollTimeout time.Duration

+ UseNonce bool

+ func NewClient(cfg Config) (*Client, error)

+ func (c *Client) ApproveSignRequest(ctx context.Context, requestID string, req *ApproveRequest) (*ApproveResponse, error)

+ func (c *Client) CreateRule(ctx context.Context, req *CreateRuleRequest) (*Rule, error)

+ func (c *Client) CreateSigner(ctx context.Context, req *CreateSignerRequest) (*Signer, error)

+ func (c *Client) CreateTemplate(ctx context.Context, req *CreateTemplateRequest) (*Template, error)

+ func (c *Client) DeleteRule(ctx context.Context, ruleID string) error

+ func (c *Client) DeleteTemplate(ctx context.Context, templateID string) error

+ func (c *Client) GetRequest(ctx context.Context, requestID string) (*RequestStatus, error)

+ func (c *Client) GetRule(ctx context.Context, ruleID string) (*Rule, error)

+ func (c *Client) GetSigner(address common.Address, chainID string) *RemoteSigner

+ func (c *Client) GetTemplate(ctx context.Context, templateID string) (*Template, error)

+ func (c *Client) Health(ctx context.Context) (*HealthResponse, error)

+ func (c *Client) InstantiateTemplate(ctx context.Context, templateID string, req *InstantiateTemplateRequest) (*InstantiateTemplateResponse, error)

+ func (c *Client) ListAuditRecords(ctx context.Context, filter *ListAuditFilter) (*ListAuditResponse, error)

+ func (c *Client) ListRequests(ctx context.Context, filter *ListRequestsFilter) (*ListRequestsResponse, error)

+ func (c *Client) ListRules(ctx context.Context, filter *ListRulesFilter) (*ListRulesResponse, error)

+ func (c *Client) ListSigners(ctx context.Context, filter *ListSignersFilter) (*ListSignersResponse, error)

+ func (c *Client) ListTemplates(ctx context.Context, filter *ListTemplatesFilter) (*ListTemplatesResponse, error)

+ func (c *Client) PreviewRule(ctx context.Context, requestID string, req *PreviewRuleRequest) (*PreviewRuleResponse, error)

+ func (c *Client) ResumeApprovalGuard(ctx context.Context) error

+ func (c *Client) RevokeInstance(ctx context.Context, ruleID string) (*RevokeInstanceResponse, error)

+ func (c *Client) Sign(ctx context.Context, req *SignRequest) (*SignResponse, error)

+ func (c *Client) SignWithOptions(ctx context.Context, req *SignRequest, waitForApproval bool) (*SignResponse, error)

+ func (c *Client) ToggleRule(ctx context.Context, ruleID string, enabled bool) (*Rule, error)

+ func (c *Client) UpdateRule(ctx context.Context, ruleID string, req *UpdateRuleRequest) (*Rule, error)

+ func (c *Client) UpdateTemplate(ctx context.Context, templateID string, req *UpdateTemplateRequest) (*Template, error)

+ type ClientInterface interface

+ ApproveSignRequest func(ctx context.Context, requestID string, req *ApproveRequest) (*ApproveResponse, error)

+ CreateRule func(ctx context.Context, req *CreateRuleRequest) (*Rule, error)

+ CreateSigner func(ctx context.Context, req *CreateSignerRequest) (*Signer, error)

+ CreateTemplate func(ctx context.Context, req *CreateTemplateRequest) (*Template, error)

+ DeleteRule func(ctx context.Context, ruleID string) error

+ DeleteTemplate func(ctx context.Context, templateID string) error

+ GetRequest func(ctx context.Context, requestID string) (*RequestStatus, error)

+ GetRule func(ctx context.Context, ruleID string) (*Rule, error)

+ GetTemplate func(ctx context.Context, templateID string) (*Template, error)

+ Health func(ctx context.Context) (*HealthResponse, error)

+ InstantiateTemplate func(ctx context.Context, templateID string, req *InstantiateTemplateRequest) (*InstantiateTemplateResponse, error)

+ ListAuditRecords func(ctx context.Context, filter *ListAuditFilter) (*ListAuditResponse, error)

+ ListRequests func(ctx context.Context, filter *ListRequestsFilter) (*ListRequestsResponse, error)

+ ListRules func(ctx context.Context, filter *ListRulesFilter) (*ListRulesResponse, error)

+ ListSigners func(ctx context.Context, filter *ListSignersFilter) (*ListSignersResponse, error)

+ ListTemplates func(ctx context.Context, filter *ListTemplatesFilter) (*ListTemplatesResponse, error)

+ PreviewRule func(ctx context.Context, requestID string, req *PreviewRuleRequest) (*PreviewRuleResponse, error)

+ RevokeInstance func(ctx context.Context, ruleID string) (*RevokeInstanceResponse, error)

+ Sign func(ctx context.Context, req *SignRequest) (*SignResponse, error)

+ SignWithOptions func(ctx context.Context, req *SignRequest, waitForApproval bool) (*SignResponse, error)

+ ToggleRule func(ctx context.Context, ruleID string, enabled bool) (*Rule, error)

+ UpdateRule func(ctx context.Context, ruleID string, req *UpdateRuleRequest) (*Rule, error)

+ UpdateTemplate func(ctx context.Context, templateID string, req *UpdateTemplateRequest) (*Template, error)

+ type Config struct

+ APIKeyID string

+ BaseURL string

+ HTTPClient *http.Client

+ PollInterval time.Duration

+ PollTimeout time.Duration

+ PrivateKey ed25519.PrivateKey

+ PrivateKeyBase64 string

+ PrivateKeyHex string

+ TLSCAFile string

+ TLSCertFile string

+ TLSKeyFile string

+ TLSSkipVerify bool

+ UseNonce *bool

+ type CreateKeystoreParams struct

+ Password string

+ type CreateRuleRequest struct

+ APIKeyID *string

+ ChainID *string

+ ChainType *string

+ Config map[string]interface{}

+ Description string

+ Enabled bool

+ Mode string

+ Name string

+ SignerAddress *string

+ Type string

+ type CreateSignerRequest struct

+ Keystore *CreateKeystoreParams

+ Type string

+ type CreateTemplateRequest struct

+ BudgetMetering map[string]interface{}

+ Config map[string]interface{}

+ Description string

+ Enabled bool

+ Mode string

+ Name string

+ TestVariables map[string]string

+ Type string

+ Variables []TemplateVariable

+ type ErrorResponse struct

+ Error string

+ Message string

+ type HashPayload struct

+ Hash string

+ type HealthResponse struct

+ Status string

+ Version string

+ type InstantiateTemplateRequest struct

+ APIKeyID *string

+ Budget *BudgetConfig

+ ChainID *string

+ ChainType *string

+ ExpiresAt *time.Time

+ ExpiresIn *string

+ Name string

+ Schedule *ScheduleConfig

+ SignerAddress *string

+ TemplateName string

+ Variables map[string]string

+ type InstantiateTemplateResponse struct

+ Budget json.RawMessage

+ Rule json.RawMessage

+ type ListAuditFilter struct

+ APIKeyID string

+ ChainID string

+ ChainType string

+ Cursor *string

+ CursorID *string

+ EndTime *time.Time

+ EventType string

+ Limit int

+ Severity string

+ SignerAddress string

+ StartTime *time.Time

+ type ListAuditResponse struct

+ HasMore bool

+ NextCursor *string

+ NextCursorID *string

+ Records []AuditRecord

+ Total int

+ type ListRequestsFilter struct

+ ChainID string

+ Cursor *string

+ CursorID *string

+ Limit int

+ SignerAddress string

+ Status string

+ type ListRequestsResponse struct

+ HasMore bool

+ NextCursor *string

+ NextCursorID *string

+ Requests []RequestStatus

+ Total int

+ type ListRulesFilter struct

+ APIKeyID string

+ ChainType string

+ Enabled *bool

+ Limit int

+ Mode string

+ Offset int

+ SignerAddress string

+ Type string

+ type ListRulesResponse struct

+ Rules []Rule

+ Total int

+ type ListSignersFilter struct

+ Limit int

+ Offset int

+ Type string

+ type ListSignersResponse struct

+ HasMore bool

+ Signers []Signer

+ Total int

+ type ListTemplatesFilter struct

+ Enabled *bool

+ Limit int

+ Offset int

+ Source string

+ Type string

+ type ListTemplatesResponse struct

+ Templates []Template

+ Total int

+ type MessagePayload struct

+ Message string

+ type MockClient struct

+ ApproveSignRequestFunc func(ctx context.Context, requestID string, req *ApproveRequest) (*ApproveResponse, error)

+ Calls map[string][]any

+ CreateRuleFunc func(ctx context.Context, req *CreateRuleRequest) (*Rule, error)

+ CreateSignerFunc func(ctx context.Context, req *CreateSignerRequest) (*Signer, error)

+ CreateTemplateFunc func(ctx context.Context, req *CreateTemplateRequest) (*Template, error)

+ DeleteRuleFunc func(ctx context.Context, ruleID string) error

+ DeleteTemplateFunc func(ctx context.Context, templateID string) error

+ GetRequestFunc func(ctx context.Context, requestID string) (*RequestStatus, error)

+ GetRuleFunc func(ctx context.Context, ruleID string) (*Rule, error)

+ GetTemplateFunc func(ctx context.Context, templateID string) (*Template, error)

+ HealthFunc func(ctx context.Context) (*HealthResponse, error)

+ InstantiateTemplateFunc func(ctx context.Context, templateID string, req *InstantiateTemplateRequest) (*InstantiateTemplateResponse, error)

+ ListAuditRecordsFunc func(ctx context.Context, filter *ListAuditFilter) (*ListAuditResponse, error)

+ ListRequestsFunc func(ctx context.Context, filter *ListRequestsFilter) (*ListRequestsResponse, error)

+ ListRulesFunc func(ctx context.Context, filter *ListRulesFilter) (*ListRulesResponse, error)

+ ListSignersFunc func(ctx context.Context, filter *ListSignersFilter) (*ListSignersResponse, error)

+ ListTemplatesFunc func(ctx context.Context, filter *ListTemplatesFilter) (*ListTemplatesResponse, error)

+ PreviewRuleFunc func(ctx context.Context, requestID string, req *PreviewRuleRequest) (*PreviewRuleResponse, error)

+ RevokeInstanceFunc func(ctx context.Context, ruleID string) (*RevokeInstanceResponse, error)

+ SignFunc func(ctx context.Context, req *SignRequest) (*SignResponse, error)

+ SignWithOptionsFunc func(ctx context.Context, req *SignRequest, waitForApproval bool) (*SignResponse, error)

+ ToggleRuleFunc func(ctx context.Context, ruleID string, enabled bool) (*Rule, error)

+ UpdateRuleFunc func(ctx context.Context, ruleID string, req *UpdateRuleRequest) (*Rule, error)

+ UpdateTemplateFunc func(ctx context.Context, templateID string, req *UpdateTemplateRequest) (*Template, error)

+ func NewMockClient() *MockClient

+ func (m *MockClient) ApproveSignRequest(ctx context.Context, requestID string, req *ApproveRequest) (*ApproveResponse, error)

+ func (m *MockClient) CreateRule(ctx context.Context, req *CreateRuleRequest) (*Rule, error)

+ func (m *MockClient) CreateSigner(ctx context.Context, req *CreateSignerRequest) (*Signer, error)

+ func (m *MockClient) CreateTemplate(ctx context.Context, req *CreateTemplateRequest) (*Template, error)

+ func (m *MockClient) DeleteRule(ctx context.Context, ruleID string) error

+ func (m *MockClient) DeleteTemplate(ctx context.Context, templateID string) error

+ func (m *MockClient) GetCalls(method string) []any

+ func (m *MockClient) GetRequest(ctx context.Context, requestID string) (*RequestStatus, error)

+ func (m *MockClient) GetRule(ctx context.Context, ruleID string) (*Rule, error)

+ func (m *MockClient) GetTemplate(ctx context.Context, templateID string) (*Template, error)

+ func (m *MockClient) Health(ctx context.Context) (*HealthResponse, error)

+ func (m *MockClient) InstantiateTemplate(ctx context.Context, templateID string, req *InstantiateTemplateRequest) (*InstantiateTemplateResponse, error)

+ func (m *MockClient) ListAuditRecords(ctx context.Context, filter *ListAuditFilter) (*ListAuditResponse, error)

+ func (m *MockClient) ListRequests(ctx context.Context, filter *ListRequestsFilter) (*ListRequestsResponse, error)

+ func (m *MockClient) ListRules(ctx context.Context, filter *ListRulesFilter) (*ListRulesResponse, error)

+ func (m *MockClient) ListSigners(ctx context.Context, filter *ListSignersFilter) (*ListSignersResponse, error)

+ func (m *MockClient) ListTemplates(ctx context.Context, filter *ListTemplatesFilter) (*ListTemplatesResponse, error)

+ func (m *MockClient) PreviewRule(ctx context.Context, requestID string, req *PreviewRuleRequest) (*PreviewRuleResponse, error)

+ func (m *MockClient) ResetCalls()

+ func (m *MockClient) RevokeInstance(ctx context.Context, ruleID string) (*RevokeInstanceResponse, error)

+ func (m *MockClient) Sign(ctx context.Context, req *SignRequest) (*SignResponse, error)

+ func (m *MockClient) SignWithOptions(ctx context.Context, req *SignRequest, waitForApproval bool) (*SignResponse, error)

+ func (m *MockClient) ToggleRule(ctx context.Context, ruleID string, enabled bool) (*Rule, error)

+ func (m *MockClient) UpdateRule(ctx context.Context, ruleID string, req *UpdateRuleRequest) (*Rule, error)

+ func (m *MockClient) UpdateTemplate(ctx context.Context, templateID string, req *UpdateTemplateRequest) (*Template, error)

+ type PreviewRuleRequest struct

+ MaxValue string

+ RuleMode string

+ RuleName string

+ RuleType string

+ type PreviewRuleResponse struct

+ Rule Rule

+ type RawMessagePayload struct

+ RawMessage []byte

+ type RemoteSigner struct

+ func (s *RemoteSigner) Close() error

+ func (s *RemoteSigner) GetAddress() common.Address

+ func (s *RemoteSigner) PersonalSign(data string) ([]byte, error)

+ func (s *RemoteSigner) PersonalSignWithContext(ctx context.Context, data string) ([]byte, error)

+ func (s *RemoteSigner) SignEIP191Message(message string) ([]byte, error)

+ func (s *RemoteSigner) SignEIP191MessageWithContext(ctx context.Context, message string) ([]byte, error)

+ func (s *RemoteSigner) SignHash(hashedData common.Hash) ([]byte, error)

+ func (s *RemoteSigner) SignHashWithContext(ctx context.Context, hashedData common.Hash) ([]byte, error)

+ func (s *RemoteSigner) SignRawMessage(raw []byte) ([]byte, error)

+ func (s *RemoteSigner) SignRawMessageWithContext(ctx context.Context, raw []byte) ([]byte, error)

+ func (s *RemoteSigner) SignTransactionWithChainID(tx *types.Transaction, chainID *big.Int) (*types.Transaction, error)

+ func (s *RemoteSigner) SignTransactionWithChainIDAndContext(ctx context.Context, tx *types.Transaction, chainID *big.Int) (*types.Transaction, error)

+ func (s *RemoteSigner) SignTypedData(typedData eip712.TypedData) ([]byte, error)

+ func (s *RemoteSigner) SignTypedDataWithContext(ctx context.Context, typedData eip712.TypedData) ([]byte, error)

+ type RequestStatus struct

+ APIKeyID string

+ ApprovedAt *time.Time

+ ApprovedBy *string

+ ChainID string

+ ChainType string

+ CompletedAt *time.Time

+ CreatedAt time.Time

+ ErrorMessage string

+ ID string

+ RuleMatchedID *string

+ SignType string

+ Signature string

+ SignedData string

+ SignerAddress string

+ Status string

+ UpdatedAt time.Time

+ type RevokeInstanceResponse struct

+ RuleID string

+ Status string

+ type Rule struct

+ APIKeyID *string

+ ChainID *string

+ ChainType *string

+ Config RuleConfig

+ CreatedAt time.Time

+ Description string

+ Enabled bool

+ ExpiresAt *time.Time

+ ID string

+ LastMatchedAt *time.Time

+ MatchCount uint64

+ Mode string

+ Name string

+ SignerAddress *string

+ Source string

+ Type string

+ UpdatedAt time.Time

+ type RuleConfig json.RawMessage

+ func (r *RuleConfig) UnmarshalJSON(data []byte) error

+ func (r RuleConfig) MarshalJSON() ([]byte, error)

+ type ScheduleConfig struct

+ Period string

+ StartAt *time.Time

+ type SignError struct

+ Message string

+ RequestID string

+ Status string

+ func (e *SignError) Error() string

+ func (e *SignError) Is(target error) bool

+ type SignRequest struct

+ ChainID string

+ Payload json.RawMessage

+ SignType string

+ SignerAddress string

+ type SignResponse struct

+ Message string

+ RequestID string

+ RuleMatched string

+ Signature string

+ SignedData string

+ Status string

+ type Signer struct

+ Address string

+ Enabled bool

+ Type string

+ type Template struct

+ BudgetMetering RuleConfig

+ Config RuleConfig

+ CreatedAt time.Time

+ Description string

+ Enabled bool

+ ID string

+ Mode string

+ Name string

+ Source string

+ Type string

+ UpdatedAt time.Time

+ Variables []TemplateVariable

+ type TemplateVariable struct

+ Default string

+ Description string

+ Name string

+ Required bool

+ Type string

+ type Transaction struct

+ Data string

+ Gas uint64

+ GasFeeCap string

+ GasPrice string

+ GasTipCap string

+ Nonce *uint64

+ To *string

+ TxType string

+ Value string

+ type TransactionPayload struct

+ Transaction *Transaction

+ type TypedData struct

+ Domain TypedDataDomain

+ Message map[string]interface{}

+ PrimaryType string

+ Types map[string][]TypedDataField

+ type TypedDataDomain struct

+ ChainId string

+ Name string

+ Salt string

+ VerifyingContract string

+ Version string

+ type TypedDataField struct

+ Name string

+ Type string

+ type TypedDataPayload struct

+ TypedData *TypedData

+ type UpdateRuleRequest struct

+ Config map[string]interface{}

+ Description string

+ Enabled bool

+ Name string

+ type UpdateTemplateRequest struct

+ Config map[string]interface{}

+ Description string

+ Enabled *bool

+ Name string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL