scanProxy

type AnsEntry struct {
	// ContractId If present, Daml contract ID of template `Splice.Ans:AnsEntry`.
	// If absent, this is a DSO-provided entry for either the DSO or an SV.
	ContractId *string `json:"contract_id,omitempty"`

	// Description Arbitrary description text supplied by `user`; may be empty.
	Description string `json:"description"`

	// ExpiresAt Time after which this ANS entry expires; if renewed, it will have a
	// new `contract_id` and `expires_at`.
	// If `null` or absent, does not expire; this is the case only for
	// special entries provided by the DSO.
	ExpiresAt *time.Time `json:"expires_at,omitempty"`

	// Name The ANS entry name.
	Name string `json:"name"`

	// Url Either empty, or an http/https URL supplied by the `user`.
	Url string `json:"url"`

	// User Owner party ID of this ANS entry.
	User string `json:"user"`
}

type BaseLookupTransferCommandStatusResponse struct {
	// Status The status of the transfer command.
	// created:
	//   The transfer command has been created and is waiting for automation to complete it.
	// sent:
	//   The transfer command has been completed and the transfer to the receiver has finished.
	// failed:
	//   The transfer command has failed permanently and nothing has been transferred. Refer to
	//   failure_reason for details. A new transfer command can be created.
	Status string `json:"status"`
}

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

type ClientInterface interface {
	// GetAmuletRules request
	GetAmuletRules(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListAnsEntries request
	ListAnsEntries(ctx context.Context, params *ListAnsEntriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// LookupAnsEntryByName request
	LookupAnsEntryByName(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// LookupAnsEntryByParty request
	LookupAnsEntryByParty(ctx context.Context, party string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAnsRulesWithBody request with any body
	GetAnsRulesWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	GetAnsRules(ctx context.Context, body GetAnsRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDsoInfo request
	GetDsoInfo(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDsoPartyId request
	GetDsoPartyId(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// LookupFeaturedAppRight request
	LookupFeaturedAppRight(ctx context.Context, providerPartyId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetOpenAndIssuingMiningRounds request
	GetOpenAndIssuingMiningRounds(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// LookupTransferCommandCounterByParty request
	LookupTransferCommandCounterByParty(ctx context.Context, party string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// LookupTransferCommandStatus request
	LookupTransferCommandStatus(ctx context.Context, params *LookupTransferCommandStatusParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// LookupTransferPreapprovalByParty request
	LookupTransferPreapprovalByParty(ctx context.Context, party string, reqEditors ...RequestEditorFn) (*http.Response, error)
}

type ClientOption func(*Client) error

type ClientWithResponses struct {
	ClientInterface
}

type ClientWithResponsesInterface interface {
	// GetAmuletRulesWithResponse request
	GetAmuletRulesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAmuletRulesResp, error)

	// ListAnsEntriesWithResponse request
	ListAnsEntriesWithResponse(ctx context.Context, params *ListAnsEntriesParams, reqEditors ...RequestEditorFn) (*ListAnsEntriesResp, error)

	// LookupAnsEntryByNameWithResponse request
	LookupAnsEntryByNameWithResponse(ctx context.Context, name string, reqEditors ...RequestEditorFn) (*LookupAnsEntryByNameResp, error)

	// LookupAnsEntryByPartyWithResponse request
	LookupAnsEntryByPartyWithResponse(ctx context.Context, party string, reqEditors ...RequestEditorFn) (*LookupAnsEntryByPartyResp, error)

	// GetAnsRulesWithBodyWithResponse request with any body
	GetAnsRulesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*GetAnsRulesResp, error)

	GetAnsRulesWithResponse(ctx context.Context, body GetAnsRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*GetAnsRulesResp, error)

	// GetDsoInfoWithResponse request
	GetDsoInfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetDsoInfoResp, error)

	// GetDsoPartyIdWithResponse request
	GetDsoPartyIdWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetDsoPartyIdResp, error)

	// LookupFeaturedAppRightWithResponse request
	LookupFeaturedAppRightWithResponse(ctx context.Context, providerPartyId string, reqEditors ...RequestEditorFn) (*LookupFeaturedAppRightResp, error)

	// GetOpenAndIssuingMiningRoundsWithResponse request
	GetOpenAndIssuingMiningRoundsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOpenAndIssuingMiningRoundsResp, error)

	// LookupTransferCommandCounterByPartyWithResponse request
	LookupTransferCommandCounterByPartyWithResponse(ctx context.Context, party string, reqEditors ...RequestEditorFn) (*LookupTransferCommandCounterByPartyResp, error)

	// LookupTransferCommandStatusWithResponse request
	LookupTransferCommandStatusWithResponse(ctx context.Context, params *LookupTransferCommandStatusParams, reqEditors ...RequestEditorFn) (*LookupTransferCommandStatusResp, error)

	// LookupTransferPreapprovalByPartyWithResponse request
	LookupTransferPreapprovalByPartyWithResponse(ctx context.Context, party string, reqEditors ...RequestEditorFn) (*LookupTransferPreapprovalByPartyResp, error)
}

type Contract struct {
	ContractId       string                 `json:"contract_id"`
	CreatedAt        string                 `json:"created_at"`
	CreatedEventBlob string                 `json:"created_event_blob"`
	Payload          map[string]interface{} `json:"payload"`
	TemplateId       string                 `json:"template_id"`
}

type ContractId = string

type ContractWithState struct {
	Contract Contract `json:"contract"`
	DomainId *string  `json:"domain_id,omitempty"`
}

type ErrorResponse struct {
	Error string `json:"error"`
}

type GetAmuletRulesProxyResponse struct {
	AmuletRules ContractWithState `json:"amulet_rules"`
}

type GetAmuletRulesResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetAmuletRulesProxyResponse
}

type GetAnsRulesJSONRequestBody = GetAnsRulesRequest

type GetAnsRulesRequest struct {
	CachedAnsRulesContractId *ContractId `json:"cached_ans_rules_contract_id,omitempty"`
	CachedAnsRulesDomainId   *string     `json:"cached_ans_rules_domain_id,omitempty"`
}

type GetAnsRulesResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetAnsRulesResponse
}

type GetAnsRulesResponse struct {
	AnsRulesUpdate MaybeCachedContractWithState `json:"ans_rules_update"`
}

type GetDsoInfoResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetDsoInfoResponse
}

type GetDsoInfoResponse struct {
	AmuletRules ContractWithState `json:"amulet_rules"`

	// DsoPartyId Party representing the whole DSO; for Scan only, also returned by
	// `/v0/dso-party-id`
	DsoPartyId string            `json:"dso_party_id"`
	DsoRules   ContractWithState `json:"dso_rules"`

	// InitialRound Initial round from which the network bootstraps
	InitialRound      *string           `json:"initial_round,omitempty"`
	LatestMiningRound ContractWithState `json:"latest_mining_round"`

	// SvNodeStates For every one of `svs` listed in `dso_rules`, a contract of the Daml
	// template `Splice.DSO.SvState.SvNodeState`. This does not include
	// states for offboarded SVs, though they may still have an on-ledger
	// state contract
	SvNodeStates []ContractWithState `json:"sv_node_states"`

	// SvPartyId Party representing the SV
	SvPartyId string `json:"sv_party_id"`

	// SvUser User ID representing the SV
	SvUser string `json:"sv_user"`

	// VotingThreshold Threshold required to pass vote requests; also known as the
	// "governance threshold", it is always derived from the number of
	// `svs` in `dso_rules`
	VotingThreshold int `json:"voting_threshold"`
}

type GetDsoPartyIdResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetDsoPartyIdResponse
}

type GetDsoPartyIdResponse struct {
	DsoPartyId string `json:"dso_party_id"`
}

type GetOpenAndIssuingMiningRoundsProxyResponse struct {
	IssuingMiningRounds []ContractWithState `json:"issuing_mining_rounds"`
	OpenMiningRounds    []ContractWithState `json:"open_mining_rounds"`
}

type GetOpenAndIssuingMiningRoundsResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetOpenAndIssuingMiningRoundsProxyResponse
}

type GinServerOptions struct {
	BaseURL      string
	Middlewares  []MiddlewareFunc
	ErrorHandler func(*gin.Context, error, int)
}

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

type ListAnsEntriesParams struct {
	NamePrefix *string `form:"name_prefix,omitempty" json:"name_prefix,omitempty"`
	PageSize   int32   `form:"page_size" json:"page_size"`
}

type ListAnsEntriesResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ListEntriesResponse
}

type ListEntriesResponse struct {
	Entries []AnsEntry `json:"entries"`
}

type LookupAnsEntryByNameResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *LookupEntryByNameResponse
	JSON404      *N404
}

type LookupAnsEntryByPartyResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *LookupEntryByPartyResponse
	JSON404      *N404
}

type LookupEntryByNameResponse struct {
	Entry AnsEntry `json:"entry"`
}

type LookupEntryByPartyResponse struct {
	Entry AnsEntry `json:"entry"`
}

type LookupFeaturedAppRightResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *LookupFeaturedAppRightResponse
}

type LookupFeaturedAppRightResponse struct {
	FeaturedAppRight *Contract `json:"featured_app_right,omitempty"`
}

type LookupTransferCommandCounterByPartyResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *LookupTransferCommandCounterByPartyResponse
	JSON404      *N404
}

type LookupTransferCommandCounterByPartyResponse struct {
	TransferCommandCounter ContractWithState `json:"transfer_command_counter"`
}

type LookupTransferCommandStatusParams struct {
	Sender string `form:"sender" json:"sender"`
	Nonce  int64  `form:"nonce" json:"nonce"`
}

type LookupTransferCommandStatusResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *LookupTransferCommandStatusResponse
	JSON404      *N404
}

type LookupTransferCommandStatusResponse struct {
	TransferCommandsByContractId TransferCommandMap `json:"transfer_commands_by_contract_id"`
}

type LookupTransferPreapprovalByPartyResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *LookupTransferPreapprovalByPartyResponse
	JSON404      *N404
}

type LookupTransferPreapprovalByPartyResponse struct {
	TransferPreapproval ContractWithState `json:"transfer_preapproval"`
}

type MaybeCachedContractWithState struct {
	Contract *Contract `json:"contract,omitempty"`
	DomainId *string   `json:"domain_id,omitempty"`
}

type MiddlewareFunc func(c *gin.Context)

type N404 = ErrorResponse

type RequestEditorFn func(ctx context.Context, req *http.Request) error

type ServerInterface interface {

	// (GET /v0/scan-proxy/amulet-rules)
	GetAmuletRules(c *gin.Context)

	// (GET /v0/scan-proxy/ans-entries)
	ListAnsEntries(c *gin.Context, params ListAnsEntriesParams)

	// (GET /v0/scan-proxy/ans-entries/by-name/{name})
	LookupAnsEntryByName(c *gin.Context, name string)

	// (GET /v0/scan-proxy/ans-entries/by-party/{party})
	LookupAnsEntryByParty(c *gin.Context, party string)

	// (POST /v0/scan-proxy/ans-rules)
	GetAnsRules(c *gin.Context)

	// (GET /v0/scan-proxy/dso)
	GetDsoInfo(c *gin.Context)

	// (GET /v0/scan-proxy/dso-party-id)
	GetDsoPartyId(c *gin.Context)

	// (GET /v0/scan-proxy/featured-apps/{provider_party_id})
	LookupFeaturedAppRight(c *gin.Context, providerPartyId string)

	// (GET /v0/scan-proxy/open-and-issuing-mining-rounds)
	GetOpenAndIssuingMiningRounds(c *gin.Context)

	// (GET /v0/scan-proxy/transfer-command-counter/{party})
	LookupTransferCommandCounterByParty(c *gin.Context, party string)

	// (GET /v0/scan-proxy/transfer-command/status)
	LookupTransferCommandStatus(c *gin.Context, params LookupTransferCommandStatusParams)

	// (GET /v0/scan-proxy/transfer-preapprovals/by-party/{party})
	LookupTransferPreapprovalByParty(c *gin.Context, party string)
}

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
	ErrorHandler       func(*gin.Context, error, int)
}

type TransferCommandContractStatus struct {
	// contains filtered or unexported fields
}

type TransferCommandContractWithStatus struct {
	Contract Contract                      `json:"contract"`
	Status   TransferCommandContractStatus `json:"status"`
}

type TransferCommandCreatedResponse = BaseLookupTransferCommandStatusResponse

type TransferCommandFailedResponse struct {
	// FailureKind The reason for the failure of the TransferCommand.
	// failed:
	//   Completing the transfer failed, check the reason for details.
	// withdrawn:
	//   The sender has withdrawn the TransferCommand before it could be completed.
	// expired:
	//   The expiry time on the TransferCommand was reached before it could be completed.
	FailureKind TransferCommandFailedResponseFailureKind `json:"failure_kind"`

	// Reason Human readable description of the failure
	Reason string `json:"reason"`

	// Status The status of the transfer command.
	// created:
	//   The transfer command has been created and is waiting for automation to complete it.
	// sent:
	//   The transfer command has been completed and the transfer to the receiver has finished.
	// failed:
	//   The transfer command has failed permanently and nothing has been transferred. Refer to
	//   failure_reason for details. A new transfer command can be created.
	Status string `json:"status"`
}

type TransferCommandFailedResponseFailureKind string

type TransferCommandMap map[string]TransferCommandContractWithStatus

type TransferCommandSentResponse = BaseLookupTransferCommandStatusResponse