guard

type AuthToken struct {
	ID    string `json:"id"`
	Token string `json:"token"`
}

type Guard interface {
	Ping(ctx context.Context) (bool, error)
	Version(ctx context.Context) (*Version, error)
	RuntimeStatus(ctx context.Context) (*RuntimeStatus, error)
	GetSignerConfig(ctx context.Context, signer string) (*WalletConfig, error)
	// Called by sequence.app when the user signs in, and signs messages/transactions/migrations.
	// Requires a valid 2FA token if enabled.
	Sign(ctx context.Context, request *SignRequest, token *AuthToken) (string, error)
	SignWith(ctx context.Context, signer string, request *SignRequest, token *AuthToken) (string, error)
	// Internal use only.
	// Only ever needs to be called once per chain.
	// Signs a preconfigured payload that the caller has no control over.
	Patch(ctx context.Context, signer string, chainId uint64, secret string) (interface{}, error)
	// Called by sequence.app when it needs to check the user's 2FA.
	// This happens during sign in, before signing messages and transactions, and when configuring 2FA.
	// Requires either a valid JWT or a signature by one of the wallet's signers.
	AuthMethods(ctx context.Context, proof *OwnershipProof) ([]string, bool, error)
	// Not currently called. Requires both a JWT and a wallet signature.
	SetPIN(ctx context.Context, pin string, timestamp uint64, signature string, chainId uint64) error
	// Not currently called. Requires both a JWT and a wallet signature.
	ResetPIN(ctx context.Context, timestamp uint64, signature string, chainId uint64) error
	// Called by sequence.app when the user configures their 2FA.
	// Requires both a JWT and a wallet signature.
	CreateTOTP(ctx context.Context, timestamp uint64, signature string, chainId uint64) (string, error)
	// Called by sequence.app when the user configures their 2FA.
	// Requires both a JWT and a wallet signature.
	CommitTOTP(ctx context.Context, token string) ([]*RecoveryCode, error)
	// Called by sequence.app when the user configures their 2FA.
	// Requires both a JWT and a wallet signature.
	ResetTOTP(ctx context.Context, timestamp uint64, signature string, chainId uint64) error
	// Called by sequence.app when the user uses a recovery code.
	// Requires either a valid JWT or a signature by one of the wallet's signers.
	Reset2FA(ctx context.Context, code string, proof *OwnershipProof) error
	// Called by sequence.app when the user is viewing their recovery codes.
	// Requires both a JWT and a wallet signature.
	RecoveryCodes(ctx context.Context, timestamp uint64, signature string, chainId uint64) ([]*RecoveryCode, error)
	// Called by sequence.app when the user is viewing their recovery codes.
	// Requires both a JWT and a wallet signature.
	ResetRecoveryCodes(ctx context.Context, timestamp uint64, signature string, chainId uint64) ([]*RecoveryCode, error)
}

type GuardClient interface {
	Ping(ctx context.Context) (bool, error)
	Version(ctx context.Context) (*Version, error)
	RuntimeStatus(ctx context.Context) (*RuntimeStatus, error)
	GetSignerConfig(ctx context.Context, signer string) (*WalletConfig, error)
	// Called by sequence.app when the user signs in, and signs messages/transactions/migrations.
	// Requires a valid 2FA token if enabled.
	Sign(ctx context.Context, request *SignRequest, token *AuthToken) (string, error)
	SignWith(ctx context.Context, signer string, request *SignRequest, token *AuthToken) (string, error)
	// Internal use only.
	// Only ever needs to be called once per chain.
	// Signs a preconfigured payload that the caller has no control over.
	Patch(ctx context.Context, signer string, chainId uint64, secret string) (interface{}, error)
	// Called by sequence.app when it needs to check the user's 2FA.
	// This happens during sign in, before signing messages and transactions, and when configuring 2FA.
	// Requires either a valid JWT or a signature by one of the wallet's signers.
	AuthMethods(ctx context.Context, proof *OwnershipProof) ([]string, bool, error)
	// Not currently called. Requires both a JWT and a wallet signature.
	SetPIN(ctx context.Context, pin string, timestamp uint64, signature string, chainId uint64) error
	// Not currently called. Requires both a JWT and a wallet signature.
	ResetPIN(ctx context.Context, timestamp uint64, signature string, chainId uint64) error
	// Called by sequence.app when the user configures their 2FA.
	// Requires both a JWT and a wallet signature.
	CreateTOTP(ctx context.Context, timestamp uint64, signature string, chainId uint64) (string, error)
	// Called by sequence.app when the user configures their 2FA.
	// Requires both a JWT and a wallet signature.
	CommitTOTP(ctx context.Context, token string) ([]*RecoveryCode, error)
	// Called by sequence.app when the user configures their 2FA.
	// Requires both a JWT and a wallet signature.
	ResetTOTP(ctx context.Context, timestamp uint64, signature string, chainId uint64) error
	// Called by sequence.app when the user uses a recovery code.
	// Requires either a valid JWT or a signature by one of the wallet's signers.
	Reset2FA(ctx context.Context, code string, proof *OwnershipProof) error
	// Called by sequence.app when the user is viewing their recovery codes.
	// Requires both a JWT and a wallet signature.
	RecoveryCodes(ctx context.Context, timestamp uint64, signature string, chainId uint64) ([]*RecoveryCode, error)
	// Called by sequence.app when the user is viewing their recovery codes.
	// Requires both a JWT and a wallet signature.
	ResetRecoveryCodes(ctx context.Context, timestamp uint64, signature string, chainId uint64) ([]*RecoveryCode, error)
}

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

type Options struct {
	// JWTAuthToken is an optional JWT token to authenticate with the guard service.
	JWTAuthToken string

	// GuardServiceURL is an optional custom URL for the Sequence Guard service.
	// If not provided, the default URL in `DefaultGuardServiceURL` will be used.
	GuardServiceURL string

	// HTTPClient is an optional custom HTTP client to use for communicating with the
	// guard service.
	HTTPClient HTTPClient
}

type OwnershipProof struct {
	Wallet    prototyp.Hash `json:"wallet"`
	Timestamp uint64        `json:"timestamp"`
	Signer    prototyp.Hash `json:"signer"`
	Signature prototyp.Hash `json:"signature"`
	ChainId   uint64        `json:"chainId"`
}

type PayloadType string

type RecoveryCode struct {
	Code string `json:"code"`
	Used bool   `json:"used"`
}

type RuntimeStatus struct {
	// overall status, true/false
	HealthOK   bool      `json:"healthOK"`
	StartTime  time.Time `json:"startTime"`
	Uptime     uint64    `json:"uptime"`
	Ver        string    `json:"ver"`
	Branch     string    `json:"branch"`
	CommitHash string    `json:"commitHash"`
}

type SignRequest struct {
	// TODO: make this a string/BigInt TODO: with webrpc v2, we can import BigInt type, etc.
	ChainId     uint64        `json:"chainId"`
	Msg         string        `json:"msg"`
	AuxData     *string       `json:"auxData"`
	Wallet      prototyp.Hash `json:"wallet"`
	PayloadType PayloadType   `json:"payloadType"`
	PayloadData string        `json:"payloadData"`
	Signatures  []*Signature  `json:"signatures"`
}

type Signature struct {
	Address   prototyp.Hash `json:"address"`
	Type      SignatureType `json:"type"`
	ImageHash prototyp.Hash `json:"imageHash"`
	Data      prototyp.Hash `json:"data"`
}

type SignatureType string

type Version struct {
	WebrpcVersion string `json:"webrpcVersion"`
	SchemaVersion string `json:"schemaVersion"`
	SchemaHash    string `json:"schemaHash"`
	AppVersion    string `json:"appVersion"`
}

type WalletConfig struct {
	Address string `json:"address"`
	Content string `json:"content"`
}

type WalletSigner struct {
	Address string `json:"address"`
	Weight  uint8  `json:"weight"`
}

type WebRPCError struct {
	Name       string `json:"error"`
	Code       int    `json:"code"`
	Message    string `json:"msg"`
	Cause      string `json:"cause,omitempty"`
	HTTPStatus int    `json:"status"`
	// contains filtered or unexported fields
}

type WebrpcGenVersions struct {
	WebrpcGenVersion string
	CodeGenName      string
	CodeGenVersion   string
	SchemaName       string
	SchemaVersion    string
}