Documentation
¶
Overview ¶
Package ccip provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.8.0 DO NOT EDIT.
Index ¶
- func NewGetTokenAdminRegistryTokenRequest(server string, instrumentId externalRef0.HashedInstrumentId) (*http.Request, error)
- func NewPostCCIPExecuteRequest(server string, body PostCCIPExecuteJSONRequestBody) (*http.Request, error)
- func NewPostCCIPExecuteRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewPostCCIPSendRequest(server string, body PostCCIPSendJSONRequestBody) (*http.Request, error)
- func NewPostCCIPSendRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewPostPerPartyRouterFactoryRequest(server string, body PostPerPartyRouterFactoryJSONRequestBody) (*http.Request, error)
- func NewPostPerPartyRouterFactoryRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func RegisterHandlers(router gin.IRouter, si ServerInterface)
- func RegisterHandlersWithOptions(router gin.IRouter, si ServerInterface, options GinServerOptions)
- type CCIPExecuteRequest
- type CCIPExecuteResponse
- type CCIPPerPartyRouterFactoryRequest
- type CCIPPerPartyRouterFactoryResponse
- type CCIPSendRequest
- type CCIPSendResponse
- type Client
- func (c *Client) GetTokenAdminRegistryToken(ctx context.Context, instrumentId externalRef0.HashedInstrumentId, ...) (*http.Response, error)
- func (c *Client) PostCCIPExecute(ctx context.Context, body PostCCIPExecuteJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) PostCCIPExecuteWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PostCCIPSend(ctx context.Context, body PostCCIPSendJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) PostCCIPSendWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PostPerPartyRouterFactory(ctx context.Context, body PostPerPartyRouterFactoryJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) PostPerPartyRouterFactoryWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- func (c *ClientWithResponses) GetTokenAdminRegistryTokenWithResponse(ctx context.Context, instrumentId externalRef0.HashedInstrumentId, ...) (*GetTokenAdminRegistryTokenResponse, error)
- func (c *ClientWithResponses) PostCCIPExecuteWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*PostCCIPExecuteResponse, error)
- func (c *ClientWithResponses) PostCCIPExecuteWithResponse(ctx context.Context, body PostCCIPExecuteJSONRequestBody, ...) (*PostCCIPExecuteResponse, error)
- func (c *ClientWithResponses) PostCCIPSendWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*PostCCIPSendResponse, error)
- func (c *ClientWithResponses) PostCCIPSendWithResponse(ctx context.Context, body PostCCIPSendJSONRequestBody, ...) (*PostCCIPSendResponse, error)
- func (c *ClientWithResponses) PostPerPartyRouterFactoryWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*PostPerPartyRouterFactoryResponse, error)
- func (c *ClientWithResponses) PostPerPartyRouterFactoryWithResponse(ctx context.Context, body PostPerPartyRouterFactoryJSONRequestBody, ...) (*PostPerPartyRouterFactoryResponse, error)
- type ClientWithResponsesInterface
- type GetTokenAdminRegistryTokenResponse
- func (r GetTokenAdminRegistryTokenResponse) ContentType() string
- func (r GetTokenAdminRegistryTokenResponse) GetBody() []byte
- func (r GetTokenAdminRegistryTokenResponse) GetJSON200() *LookupTokenPoolResponse
- func (r GetTokenAdminRegistryTokenResponse) GetJSON400() *externalRef0.N400
- func (r GetTokenAdminRegistryTokenResponse) GetJSON404() *externalRef0.N404
- func (r GetTokenAdminRegistryTokenResponse) GetJSON500() *externalRef0.N500
- func (r GetTokenAdminRegistryTokenResponse) Status() string
- func (r GetTokenAdminRegistryTokenResponse) StatusCode() int
- type GinServerOptions
- type HttpRequestDoer
- type LookupTokenPoolResponse
- type MiddlewareFunc
- type PostCCIPExecuteJSONRequestBody
- type PostCCIPExecuteResponse
- func (r PostCCIPExecuteResponse) ContentType() string
- func (r PostCCIPExecuteResponse) GetBody() []byte
- func (r PostCCIPExecuteResponse) GetJSON200() *CCIPExecuteResponse
- func (r PostCCIPExecuteResponse) GetJSON400() *externalRef0.N400
- func (r PostCCIPExecuteResponse) GetJSON404() *externalRef0.N404
- func (r PostCCIPExecuteResponse) GetJSON500() *externalRef0.N500
- func (r PostCCIPExecuteResponse) Status() string
- func (r PostCCIPExecuteResponse) StatusCode() int
- type PostCCIPSendJSONRequestBody
- type PostCCIPSendResponse
- func (r PostCCIPSendResponse) ContentType() string
- func (r PostCCIPSendResponse) GetBody() []byte
- func (r PostCCIPSendResponse) GetJSON200() *CCIPSendResponse
- func (r PostCCIPSendResponse) GetJSON400() *externalRef0.N400
- func (r PostCCIPSendResponse) GetJSON404() *externalRef0.N404
- func (r PostCCIPSendResponse) GetJSON500() *externalRef0.N500
- func (r PostCCIPSendResponse) Status() string
- func (r PostCCIPSendResponse) StatusCode() int
- type PostPerPartyRouterFactoryJSONRequestBody
- type PostPerPartyRouterFactoryResponse
- func (r PostPerPartyRouterFactoryResponse) ContentType() string
- func (r PostPerPartyRouterFactoryResponse) GetBody() []byte
- func (r PostPerPartyRouterFactoryResponse) GetJSON200() *CCIPPerPartyRouterFactoryResponse
- func (r PostPerPartyRouterFactoryResponse) GetJSON400() *externalRef0.N400
- func (r PostPerPartyRouterFactoryResponse) GetJSON404() *externalRef0.N404
- func (r PostPerPartyRouterFactoryResponse) GetJSON500() *externalRef0.N500
- func (r PostPerPartyRouterFactoryResponse) Status() string
- func (r PostPerPartyRouterFactoryResponse) StatusCode() int
- type RequestEditorFn
- type ServerInterface
- type ServerInterfaceWrapper
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewGetTokenAdminRegistryTokenRequest ¶
func NewGetTokenAdminRegistryTokenRequest(server string, instrumentId externalRef0.HashedInstrumentId) (*http.Request, error)
NewGetTokenAdminRegistryTokenRequest constructs an http.Request for the GetTokenAdminRegistryToken method
func NewPostCCIPExecuteRequest ¶
func NewPostCCIPExecuteRequest(server string, body PostCCIPExecuteJSONRequestBody) (*http.Request, error)
NewPostCCIPExecuteRequest calls the generic PostCCIPExecute builder with application/json body
func NewPostCCIPExecuteRequestWithBody ¶
func NewPostCCIPExecuteRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewPostCCIPExecuteRequestWithBody constructs an http.Request for the PostCCIPExecute method, with any body, and a specified content type
func NewPostCCIPSendRequest ¶
func NewPostCCIPSendRequest(server string, body PostCCIPSendJSONRequestBody) (*http.Request, error)
NewPostCCIPSendRequest calls the generic PostCCIPSend builder with application/json body
func NewPostCCIPSendRequestWithBody ¶
func NewPostCCIPSendRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewPostCCIPSendRequestWithBody constructs an http.Request for the PostCCIPSend method, with any body, and a specified content type
func NewPostPerPartyRouterFactoryRequest ¶
func NewPostPerPartyRouterFactoryRequest(server string, body PostPerPartyRouterFactoryJSONRequestBody) (*http.Request, error)
NewPostPerPartyRouterFactoryRequest calls the generic PostPerPartyRouterFactory builder with application/json body
func NewPostPerPartyRouterFactoryRequestWithBody ¶
func NewPostPerPartyRouterFactoryRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewPostPerPartyRouterFactoryRequestWithBody constructs an http.Request for the PostPerPartyRouterFactory method, with any body, and a specified content type
func RegisterHandlers ¶
func RegisterHandlers(router gin.IRouter, si ServerInterface)
RegisterHandlers creates http.Handler with routing matching OpenAPI spec.
func RegisterHandlersWithOptions ¶
func RegisterHandlersWithOptions(router gin.IRouter, si ServerInterface, options GinServerOptions)
RegisterHandlersWithOptions creates http.Handler with additional options
Types ¶
type CCIPExecuteRequest ¶
type CCIPExecuteRequest struct {
// EncodedMessage The CCIP message to be executed, encoded as a hex string.
EncodedMessage string `json:"encodedMessage"`
// Receiver The unique identifier of a party.
//
// Example: some-party::1220131b86f50178e6f7aabe62ef79e79b4964a526a1c557776409f448cbcd2406ce
Receiver externalRef0.PartyId `json:"receiver"`
}
CCIPExecuteRequest defines model for CCIPExecuteRequest.
type CCIPExecuteResponse ¶
type CCIPExecuteResponse struct {
// ContextData The context to be passed along to CCIP.
ContextData map[string]interface{} `json:"contextData"`
DisclosedContracts []externalRef0.DisclosedContract `json:"disclosedContracts"`
// TokenPool The raw InstanceAddress of a contract, in the form of "prefix@owner", where prefix is the InstanceId of the contract.
//
// Example: some-contract-fgtlw@ccipOwner::1220131b86f50178e6f7aabe62ef79e79b4964a526a1c557776409f448cbcd2406ce
TokenPool *externalRef0.RawInstanceAddress `json:"tokenPool,omitempty"`
}
CCIPExecuteResponse defines model for CCIPExecuteResponse.
type CCIPPerPartyRouterFactoryRequest ¶
type CCIPPerPartyRouterFactoryRequest struct {
// PartyID The unique identifier of a party.
//
// Example: some-party::1220131b86f50178e6f7aabe62ef79e79b4964a526a1c557776409f448cbcd2406ce
PartyID externalRef0.PartyId `json:"partyID"`
}
CCIPPerPartyRouterFactoryRequest defines model for CCIPPerPartyRouterFactoryRequest.
type CCIPPerPartyRouterFactoryResponse ¶
type CCIPPerPartyRouterFactoryResponse struct {
// ContractId The unique identifier of a contract.
//
// Example: 00929f6a675c128bb54bef77a8cad8d330badd4330cf71f6a19b596b01f4b66b2dca121220cd655ce27fae64bdf6a203fcd987727de81c3762e46b1882ce2c2fbf0a72c64f
ContractId externalRef0.ContractId `json:"contractId"`
// DisclosedContracts Disclosures for all contracts required for the caller to instantiate a PerPartyRouter
DisclosedContracts []externalRef0.DisclosedContract `json:"disclosedContracts"`
// InstanceAddress The InstanceAddress of a contract, the keccak256 hash of the RawInstanceAddress.
//
// Example: 0x9d24274102a5d2f57506d48dee1394e33f7cef9a9c0920ee714d6f4a216a21a9
InstanceAddress externalRef0.InstanceAddress `json:"instanceAddress"`
// RawInstanceAddress The raw InstanceAddress of a contract, in the form of "prefix@owner", where prefix is the InstanceId of the contract.
//
// Example: some-contract-fgtlw@ccipOwner::1220131b86f50178e6f7aabe62ef79e79b4964a526a1c557776409f448cbcd2406ce
RawInstanceAddress externalRef0.RawInstanceAddress `json:"rawInstanceAddress"`
}
CCIPPerPartyRouterFactoryResponse defines model for CCIPPerPartyRouterFactoryResponse.
type CCIPSendRequest ¶
type CCIPSendRequest struct {
// Message A message to be sent from Canton.
Message externalRef0.Message `json:"message"`
SenderRequiredCCVs *[]externalRef0.RawOrHashedAddress `json:"senderRequiredCCVs,omitempty"`
TokenPoolRequiredCCVs *[]externalRef0.RawOrHashedAddress `json:"tokenPoolRequiredCCVs,omitempty"`
}
CCIPSendRequest defines model for CCIPSendRequest.
type CCIPSendResponse ¶
type CCIPSendResponse struct {
// Ccvs A list of requested CCVs containing their addresses.
// If default CCVs apply, this list might contain more CCVs than originally requested.
//
//
// Example: ["committeeverifier-abcde@ccipOwner::1220131b86f50178e6f7aabe62ef79e79b4964a526a1c557776409f448cbcd2406ce","0x4bed5af0e77b4d7a552a1f933b13c275bbdc231b8499b2e14edcc634a6869a5f"]
Ccvs []externalRef0.RawOrHashedAddress `json:"ccvs"`
// ContextData The context to be passed along to CCIP.
ContextData map[string]interface{} `json:"contextData"`
DisclosedContracts []externalRef0.DisclosedContract `json:"disclosedContracts"`
// Executor An address which can be either a RawInstanceAddress or an InstanceAddress.
Executor *externalRef0.RawOrHashedAddress `json:"executor,omitempty"`
// FeeTokenConfigCid TokenConfig contract ID for the message fee token.
FeeTokenConfigCid string `json:"feeTokenConfigCid"`
}
CCIPSendResponse defines model for CCIPSendResponse.
type Client ¶
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
}
Client which conforms to the OpenAPI3 specification for this service.
func NewClient ¶
func NewClient(server string, opts ...ClientOption) (*Client, error)
Creates a new Client, with reasonable defaults
func (*Client) GetTokenAdminRegistryToken ¶
func (c *Client) GetTokenAdminRegistryToken(ctx context.Context, instrumentId externalRef0.HashedInstrumentId, reqEditors ...RequestEditorFn) (*http.Response, error)
GetTokenAdminRegistryToken performs a GET /ccip/v1/global/TokenAdminRegistry/token/{instrumentId} (the `GetTokenAdminRegistryToken` operationId) request.
Get the token pool for a given instrument from the token admin registry.
func (*Client) PostCCIPExecute ¶
func (c *Client) PostCCIPExecute(ctx context.Context, body PostCCIPExecuteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
PostCCIPExecute performs a POST /ccip/v1/global/message/execute (the `PostCCIPExecute` operationId) request. Takes a body of the `application/json` content type.
Get the explicit disclosures for executing a CCIP message on Canton.
func (*Client) PostCCIPExecuteWithBody ¶
func (c *Client) PostCCIPExecuteWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostCCIPExecuteWithBody performs a POST /ccip/v1/global/message/execute (the `PostCCIPExecute` operationId) request, with any type of body and a specified content type.
Get the explicit disclosures for executing a CCIP message on Canton.
func (*Client) PostCCIPSend ¶
func (c *Client) PostCCIPSend(ctx context.Context, body PostCCIPSendJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
PostCCIPSend performs a POST /ccip/v1/global/message/send (the `PostCCIPSend` operationId) request. Takes a body of the `application/json` content type.
Get the explicit disclosure for sending a CCIP message from Canton.
func (*Client) PostCCIPSendWithBody ¶
func (c *Client) PostCCIPSendWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostCCIPSendWithBody performs a POST /ccip/v1/global/message/send (the `PostCCIPSend` operationId) request, with any type of body and a specified content type.
Get the explicit disclosure for sending a CCIP message from Canton.
func (*Client) PostPerPartyRouterFactory ¶
func (c *Client) PostPerPartyRouterFactory(ctx context.Context, body PostPerPartyRouterFactoryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
PostPerPartyRouterFactory performs a POST /ccip/v1/global/PerPartyRouter/factory (the `PostPerPartyRouterFactory` operationId) request. Takes a body of the `application/json` content type.
Get the explicit disclosures for instantiating a PerPartyRouter using the PerPartyRouterFactory.
func (*Client) PostPerPartyRouterFactoryWithBody ¶
func (c *Client) PostPerPartyRouterFactoryWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostPerPartyRouterFactoryWithBody performs a POST /ccip/v1/global/PerPartyRouter/factory (the `PostPerPartyRouterFactory` operationId) request, with any type of body and a specified content type.
Get the explicit disclosures for instantiating a PerPartyRouter using the PerPartyRouterFactory.
type ClientInterface ¶
type ClientInterface interface {
// PostPerPartyRouterFactoryWithBody performs a POST /ccip/v1/global/PerPartyRouter/factory (the `PostPerPartyRouterFactory` operationId) request,
// with any type of body and a specified content type.
//
// Get the explicit disclosures for instantiating a PerPartyRouter using the PerPartyRouterFactory.
PostPerPartyRouterFactoryWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostPerPartyRouterFactory performs a POST /ccip/v1/global/PerPartyRouter/factory (the `PostPerPartyRouterFactory` operationId) request.
// Takes a body of the `application/json` content type.
//
// Get the explicit disclosures for instantiating a PerPartyRouter using the PerPartyRouterFactory.
PostPerPartyRouterFactory(ctx context.Context, body PostPerPartyRouterFactoryJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetTokenAdminRegistryToken performs a GET /ccip/v1/global/TokenAdminRegistry/token/{instrumentId} (the `GetTokenAdminRegistryToken` operationId) request.
//
// Get the token pool for a given instrument from the token admin registry.
GetTokenAdminRegistryToken(ctx context.Context, instrumentId externalRef0.HashedInstrumentId, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostCCIPExecuteWithBody performs a POST /ccip/v1/global/message/execute (the `PostCCIPExecute` operationId) request,
// with any type of body and a specified content type.
//
// Get the explicit disclosures for executing a CCIP message on Canton.
PostCCIPExecuteWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostCCIPExecute performs a POST /ccip/v1/global/message/execute (the `PostCCIPExecute` operationId) request.
// Takes a body of the `application/json` content type.
//
// Get the explicit disclosures for executing a CCIP message on Canton.
PostCCIPExecute(ctx context.Context, body PostCCIPExecuteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostCCIPSendWithBody performs a POST /ccip/v1/global/message/send (the `PostCCIPSend` operationId) request,
// with any type of body and a specified content type.
//
// Get the explicit disclosure for sending a CCIP message from Canton.
PostCCIPSendWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostCCIPSend performs a POST /ccip/v1/global/message/send (the `PostCCIPSend` operationId) request.
// Takes a body of the `application/json` content type.
//
// Get the explicit disclosure for sending a CCIP message from Canton.
PostCCIPSend(ctx context.Context, body PostCCIPSendJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}
The interface specification for the client above.
type ClientOption ¶
ClientOption allows setting custom parameters during construction
func WithHTTPClient ¶
func WithHTTPClient(doer HttpRequestDoer) ClientOption
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.
func WithRequestEditorFn ¶
func WithRequestEditorFn(fn RequestEditorFn) ClientOption
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
ClientWithResponses builds on ClientInterface to offer response payloads
func NewClientWithResponses ¶
func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) GetTokenAdminRegistryTokenWithResponse ¶
func (c *ClientWithResponses) GetTokenAdminRegistryTokenWithResponse(ctx context.Context, instrumentId externalRef0.HashedInstrumentId, reqEditors ...RequestEditorFn) (*GetTokenAdminRegistryTokenResponse, error)
GetTokenAdminRegistryTokenWithResponse performs a GET /ccip/v1/global/TokenAdminRegistry/token/{instrumentId} (the `GetTokenAdminRegistryToken` operationId) request.
Get the token pool for a given instrument from the token admin registry.
Returns a wrapper object for the known response body format(s).
func (*ClientWithResponses) PostCCIPExecuteWithBodyWithResponse ¶
func (c *ClientWithResponses) PostCCIPExecuteWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostCCIPExecuteResponse, error)
PostCCIPExecuteWithBodyWithResponse performs a POST /ccip/v1/global/message/execute (the `PostCCIPExecute` operationId) request, with any type of body and a specified content type.
Get the explicit disclosures for executing a CCIP message on Canton.
Returns a wrapper object for the known response body format(s).
func (*ClientWithResponses) PostCCIPExecuteWithResponse ¶
func (c *ClientWithResponses) PostCCIPExecuteWithResponse(ctx context.Context, body PostCCIPExecuteJSONRequestBody, reqEditors ...RequestEditorFn) (*PostCCIPExecuteResponse, error)
PostCCIPExecuteWithResponse performs a POST /ccip/v1/global/message/execute (the `PostCCIPExecute` operationId) request. Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Get the explicit disclosures for executing a CCIP message on Canton.
func (*ClientWithResponses) PostCCIPSendWithBodyWithResponse ¶
func (c *ClientWithResponses) PostCCIPSendWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostCCIPSendResponse, error)
PostCCIPSendWithBodyWithResponse performs a POST /ccip/v1/global/message/send (the `PostCCIPSend` operationId) request, with any type of body and a specified content type.
Get the explicit disclosure for sending a CCIP message from Canton.
Returns a wrapper object for the known response body format(s).
func (*ClientWithResponses) PostCCIPSendWithResponse ¶
func (c *ClientWithResponses) PostCCIPSendWithResponse(ctx context.Context, body PostCCIPSendJSONRequestBody, reqEditors ...RequestEditorFn) (*PostCCIPSendResponse, error)
PostCCIPSendWithResponse performs a POST /ccip/v1/global/message/send (the `PostCCIPSend` operationId) request. Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Get the explicit disclosure for sending a CCIP message from Canton.
func (*ClientWithResponses) PostPerPartyRouterFactoryWithBodyWithResponse ¶
func (c *ClientWithResponses) PostPerPartyRouterFactoryWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostPerPartyRouterFactoryResponse, error)
PostPerPartyRouterFactoryWithBodyWithResponse performs a POST /ccip/v1/global/PerPartyRouter/factory (the `PostPerPartyRouterFactory` operationId) request, with any type of body and a specified content type.
Get the explicit disclosures for instantiating a PerPartyRouter using the PerPartyRouterFactory.
Returns a wrapper object for the known response body format(s).
func (*ClientWithResponses) PostPerPartyRouterFactoryWithResponse ¶
func (c *ClientWithResponses) PostPerPartyRouterFactoryWithResponse(ctx context.Context, body PostPerPartyRouterFactoryJSONRequestBody, reqEditors ...RequestEditorFn) (*PostPerPartyRouterFactoryResponse, error)
PostPerPartyRouterFactoryWithResponse performs a POST /ccip/v1/global/PerPartyRouter/factory (the `PostPerPartyRouterFactory` operationId) request. Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Get the explicit disclosures for instantiating a PerPartyRouter using the PerPartyRouterFactory.
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// PostPerPartyRouterFactoryWithBodyWithResponse performs a POST /ccip/v1/global/PerPartyRouter/factory (the `PostPerPartyRouterFactory` operationId) request,
// with any type of body and a specified content type.
//
// Get the explicit disclosures for instantiating a PerPartyRouter using the PerPartyRouterFactory.
//
// Returns a wrapper object for the known response body format(s).
PostPerPartyRouterFactoryWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostPerPartyRouterFactoryResponse, error)
// PostPerPartyRouterFactoryWithResponse performs a POST /ccip/v1/global/PerPartyRouter/factory (the `PostPerPartyRouterFactory` operationId) request.
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Get the explicit disclosures for instantiating a PerPartyRouter using the PerPartyRouterFactory.
PostPerPartyRouterFactoryWithResponse(ctx context.Context, body PostPerPartyRouterFactoryJSONRequestBody, reqEditors ...RequestEditorFn) (*PostPerPartyRouterFactoryResponse, error)
// GetTokenAdminRegistryTokenWithResponse performs a GET /ccip/v1/global/TokenAdminRegistry/token/{instrumentId} (the `GetTokenAdminRegistryToken` operationId) request.
//
// Get the token pool for a given instrument from the token admin registry.
//
// Returns a wrapper object for the known response body format(s).
GetTokenAdminRegistryTokenWithResponse(ctx context.Context, instrumentId externalRef0.HashedInstrumentId, reqEditors ...RequestEditorFn) (*GetTokenAdminRegistryTokenResponse, error)
// PostCCIPExecuteWithBodyWithResponse performs a POST /ccip/v1/global/message/execute (the `PostCCIPExecute` operationId) request,
// with any type of body and a specified content type.
//
// Get the explicit disclosures for executing a CCIP message on Canton.
//
// Returns a wrapper object for the known response body format(s).
PostCCIPExecuteWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostCCIPExecuteResponse, error)
// PostCCIPExecuteWithResponse performs a POST /ccip/v1/global/message/execute (the `PostCCIPExecute` operationId) request.
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Get the explicit disclosures for executing a CCIP message on Canton.
PostCCIPExecuteWithResponse(ctx context.Context, body PostCCIPExecuteJSONRequestBody, reqEditors ...RequestEditorFn) (*PostCCIPExecuteResponse, error)
// PostCCIPSendWithBodyWithResponse performs a POST /ccip/v1/global/message/send (the `PostCCIPSend` operationId) request,
// with any type of body and a specified content type.
//
// Get the explicit disclosure for sending a CCIP message from Canton.
//
// Returns a wrapper object for the known response body format(s).
PostCCIPSendWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostCCIPSendResponse, error)
// PostCCIPSendWithResponse performs a POST /ccip/v1/global/message/send (the `PostCCIPSend` operationId) request.
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Get the explicit disclosure for sending a CCIP message from Canton.
PostCCIPSendWithResponse(ctx context.Context, body PostCCIPSendJSONRequestBody, reqEditors ...RequestEditorFn) (*PostCCIPSendResponse, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
type GetTokenAdminRegistryTokenResponse ¶
type GetTokenAdminRegistryTokenResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *LookupTokenPoolResponse
// JSON400 the response for an HTTP 400 `application/json` response
JSON400 *externalRef0.N400
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *externalRef0.N404
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *externalRef0.N500
}
func ParseGetTokenAdminRegistryTokenResponse ¶
func ParseGetTokenAdminRegistryTokenResponse(rsp *http.Response) (*GetTokenAdminRegistryTokenResponse, error)
ParseGetTokenAdminRegistryTokenResponse parses an HTTP response from a GetTokenAdminRegistryTokenWithResponse call
func (GetTokenAdminRegistryTokenResponse) ContentType ¶
func (r GetTokenAdminRegistryTokenResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (GetTokenAdminRegistryTokenResponse) GetBody ¶
func (r GetTokenAdminRegistryTokenResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (GetTokenAdminRegistryTokenResponse) GetJSON200 ¶
func (r GetTokenAdminRegistryTokenResponse) GetJSON200() *LookupTokenPoolResponse
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (GetTokenAdminRegistryTokenResponse) GetJSON400 ¶
func (r GetTokenAdminRegistryTokenResponse) GetJSON400() *externalRef0.N400
GetJSON400 returns the response for an HTTP 400 `application/json` response
func (GetTokenAdminRegistryTokenResponse) GetJSON404 ¶
func (r GetTokenAdminRegistryTokenResponse) GetJSON404() *externalRef0.N404
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (GetTokenAdminRegistryTokenResponse) GetJSON500 ¶
func (r GetTokenAdminRegistryTokenResponse) GetJSON500() *externalRef0.N500
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (GetTokenAdminRegistryTokenResponse) Status ¶
func (r GetTokenAdminRegistryTokenResponse) Status() string
Status returns HTTPResponse.Status
func (GetTokenAdminRegistryTokenResponse) StatusCode ¶
func (r GetTokenAdminRegistryTokenResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GinServerOptions ¶
type GinServerOptions struct {
BaseURL string
Middlewares []MiddlewareFunc
ErrorHandler func(*gin.Context, error, int)
}
GinServerOptions provides options for the Gin server.
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type LookupTokenPoolResponse ¶
type LookupTokenPoolResponse struct {
// RawInstanceAddress The raw InstanceAddress of a contract, in the form of "prefix@owner", where prefix is the InstanceId of the contract.
//
// Example: some-contract-fgtlw@ccipOwner::1220131b86f50178e6f7aabe62ef79e79b4964a526a1c557776409f448cbcd2406ce
RawInstanceAddress externalRef0.RawInstanceAddress `json:"rawInstanceAddress"`
}
LookupTokenPoolResponse defines model for LookupTokenPoolResponse.
type MiddlewareFunc ¶
type PostCCIPExecuteJSONRequestBody ¶
type PostCCIPExecuteJSONRequestBody = CCIPExecuteRequest
PostCCIPExecuteJSONRequestBody defines body for PostCCIPExecute for application/json ContentType.
type PostCCIPExecuteResponse ¶
type PostCCIPExecuteResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *CCIPExecuteResponse
// JSON400 the response for an HTTP 400 `application/json` response
JSON400 *externalRef0.N400
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *externalRef0.N404
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *externalRef0.N500
}
func ParsePostCCIPExecuteResponse ¶
func ParsePostCCIPExecuteResponse(rsp *http.Response) (*PostCCIPExecuteResponse, error)
ParsePostCCIPExecuteResponse parses an HTTP response from a PostCCIPExecuteWithResponse call
func (PostCCIPExecuteResponse) ContentType ¶
func (r PostCCIPExecuteResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (PostCCIPExecuteResponse) GetBody ¶
func (r PostCCIPExecuteResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (PostCCIPExecuteResponse) GetJSON200 ¶
func (r PostCCIPExecuteResponse) GetJSON200() *CCIPExecuteResponse
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (PostCCIPExecuteResponse) GetJSON400 ¶
func (r PostCCIPExecuteResponse) GetJSON400() *externalRef0.N400
GetJSON400 returns the response for an HTTP 400 `application/json` response
func (PostCCIPExecuteResponse) GetJSON404 ¶
func (r PostCCIPExecuteResponse) GetJSON404() *externalRef0.N404
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (PostCCIPExecuteResponse) GetJSON500 ¶
func (r PostCCIPExecuteResponse) GetJSON500() *externalRef0.N500
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (PostCCIPExecuteResponse) Status ¶
func (r PostCCIPExecuteResponse) Status() string
Status returns HTTPResponse.Status
func (PostCCIPExecuteResponse) StatusCode ¶
func (r PostCCIPExecuteResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostCCIPSendJSONRequestBody ¶
type PostCCIPSendJSONRequestBody = CCIPSendRequest
PostCCIPSendJSONRequestBody defines body for PostCCIPSend for application/json ContentType.
type PostCCIPSendResponse ¶
type PostCCIPSendResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *CCIPSendResponse
// JSON400 the response for an HTTP 400 `application/json` response
JSON400 *externalRef0.N400
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *externalRef0.N404
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *externalRef0.N500
}
func ParsePostCCIPSendResponse ¶
func ParsePostCCIPSendResponse(rsp *http.Response) (*PostCCIPSendResponse, error)
ParsePostCCIPSendResponse parses an HTTP response from a PostCCIPSendWithResponse call
func (PostCCIPSendResponse) ContentType ¶
func (r PostCCIPSendResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (PostCCIPSendResponse) GetBody ¶
func (r PostCCIPSendResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (PostCCIPSendResponse) GetJSON200 ¶
func (r PostCCIPSendResponse) GetJSON200() *CCIPSendResponse
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (PostCCIPSendResponse) GetJSON400 ¶
func (r PostCCIPSendResponse) GetJSON400() *externalRef0.N400
GetJSON400 returns the response for an HTTP 400 `application/json` response
func (PostCCIPSendResponse) GetJSON404 ¶
func (r PostCCIPSendResponse) GetJSON404() *externalRef0.N404
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (PostCCIPSendResponse) GetJSON500 ¶
func (r PostCCIPSendResponse) GetJSON500() *externalRef0.N500
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (PostCCIPSendResponse) Status ¶
func (r PostCCIPSendResponse) Status() string
Status returns HTTPResponse.Status
func (PostCCIPSendResponse) StatusCode ¶
func (r PostCCIPSendResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostPerPartyRouterFactoryJSONRequestBody ¶
type PostPerPartyRouterFactoryJSONRequestBody = CCIPPerPartyRouterFactoryRequest
PostPerPartyRouterFactoryJSONRequestBody defines body for PostPerPartyRouterFactory for application/json ContentType.
type PostPerPartyRouterFactoryResponse ¶
type PostPerPartyRouterFactoryResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *CCIPPerPartyRouterFactoryResponse
// JSON400 the response for an HTTP 400 `application/json` response
JSON400 *externalRef0.N400
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *externalRef0.N404
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *externalRef0.N500
}
func ParsePostPerPartyRouterFactoryResponse ¶
func ParsePostPerPartyRouterFactoryResponse(rsp *http.Response) (*PostPerPartyRouterFactoryResponse, error)
ParsePostPerPartyRouterFactoryResponse parses an HTTP response from a PostPerPartyRouterFactoryWithResponse call
func (PostPerPartyRouterFactoryResponse) ContentType ¶
func (r PostPerPartyRouterFactoryResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (PostPerPartyRouterFactoryResponse) GetBody ¶
func (r PostPerPartyRouterFactoryResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (PostPerPartyRouterFactoryResponse) GetJSON200 ¶
func (r PostPerPartyRouterFactoryResponse) GetJSON200() *CCIPPerPartyRouterFactoryResponse
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (PostPerPartyRouterFactoryResponse) GetJSON400 ¶
func (r PostPerPartyRouterFactoryResponse) GetJSON400() *externalRef0.N400
GetJSON400 returns the response for an HTTP 400 `application/json` response
func (PostPerPartyRouterFactoryResponse) GetJSON404 ¶
func (r PostPerPartyRouterFactoryResponse) GetJSON404() *externalRef0.N404
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (PostPerPartyRouterFactoryResponse) GetJSON500 ¶
func (r PostPerPartyRouterFactoryResponse) GetJSON500() *externalRef0.N500
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (PostPerPartyRouterFactoryResponse) Status ¶
func (r PostPerPartyRouterFactoryResponse) Status() string
Status returns HTTPResponse.Status
func (PostPerPartyRouterFactoryResponse) StatusCode ¶
func (r PostPerPartyRouterFactoryResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type ServerInterface ¶
type ServerInterface interface {
// (POST /ccip/v1/global/PerPartyRouter/factory)
PostPerPartyRouterFactory(c *gin.Context)
// (GET /ccip/v1/global/TokenAdminRegistry/token/{instrumentId})
GetTokenAdminRegistryToken(c *gin.Context, instrumentId externalRef0.HashedInstrumentId)
// (POST /ccip/v1/global/message/execute)
PostCCIPExecute(c *gin.Context)
// (POST /ccip/v1/global/message/send)
PostCCIPSend(c *gin.Context)
}
ServerInterface represents all server handlers.
type ServerInterfaceWrapper ¶
type ServerInterfaceWrapper struct {
Handler ServerInterface
HandlerMiddlewares []MiddlewareFunc
ErrorHandler func(*gin.Context, error, int)
}
ServerInterfaceWrapper converts contexts to parameters.
func (*ServerInterfaceWrapper) GetTokenAdminRegistryToken ¶
func (siw *ServerInterfaceWrapper) GetTokenAdminRegistryToken(c *gin.Context)
GetTokenAdminRegistryToken operation middleware
func (*ServerInterfaceWrapper) PostCCIPExecute ¶
func (siw *ServerInterfaceWrapper) PostCCIPExecute(c *gin.Context)
PostCCIPExecute operation middleware
func (*ServerInterfaceWrapper) PostCCIPSend ¶
func (siw *ServerInterfaceWrapper) PostCCIPSend(c *gin.Context)
PostCCIPSend operation middleware
func (*ServerInterfaceWrapper) PostPerPartyRouterFactory ¶
func (siw *ServerInterfaceWrapper) PostPerPartyRouterFactory(c *gin.Context)
PostPerPartyRouterFactory operation middleware