Skip to content

Latest commit

 

History

History
662 lines (431 loc) · 17.5 KB

IbcAPI.md

File metadata and controls

662 lines (431 loc) · 17.5 KB

\IbcAPI

All URIs are relative to https://api-mainnet.celenium.io/v1

Method HTTP request Description
GetIbcChannel Get /ibc/channel/{id} Get ibc channel info
GetIbcChannels Get /ibc/channel Get ibc channels info
GetIbcClient Get /ibc/client/{id} Get ibc client info
GetIbcClients Get /ibc/client Get ibc clients info
GetIbcConn Get /ibc/connection/{id} Get ibc connection info
GetIbcConns Get /ibc/connection Get ibc connections info
GetIbcRelayers Get /ibc/relayers List ibc relayers
GetIbcTransfer Get /ibc/transfer/{id} Get transfer by id
GetIbcTransfers Get /ibc/transfer Get ibc transfers info

GetIbcChannel

ResponsesIbcChannel GetIbcChannel(ctx, id).Execute()

Get ibc channel info

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/celenium-io/celenium-api-go"
)

func main() {
	id := "id_example" // string | IBC channel id

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.IbcAPI.GetIbcChannel(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `IbcAPI.GetIbcChannel``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetIbcChannel`: ResponsesIbcChannel
	fmt.Fprintf(os.Stdout, "Response from `IbcAPI.GetIbcChannel`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string IBC channel id

Other Parameters

Other parameters are passed through a pointer to a apiGetIbcChannelRequest struct via the builder pattern

Name Type Description Notes

Return type

ResponsesIbcChannel

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetIbcChannels

[]ResponsesIbcChannel GetIbcChannels(ctx).Limit(limit).Offset(offset).Sort(sort).ClientId(clientId).ConnectionId(connectionId).Status(status).Execute()

Get ibc channels info

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/celenium-io/celenium-api-go"
)

func main() {
	limit := int32(56) // int32 | Count of requested entities (optional)
	offset := int32(56) // int32 | Offset (optional)
	sort := "sort_example" // string | Sort order. Default: desc (optional)
	clientId := "clientId_example" // string | Client id (optional)
	connectionId := "connectionId_example" // string | Connection id (optional)
	status := "status_example" // string | Channel status (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.IbcAPI.GetIbcChannels(context.Background()).Limit(limit).Offset(offset).Sort(sort).ClientId(clientId).ConnectionId(connectionId).Status(status).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `IbcAPI.GetIbcChannels``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetIbcChannels`: []ResponsesIbcChannel
	fmt.Fprintf(os.Stdout, "Response from `IbcAPI.GetIbcChannels`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetIbcChannelsRequest struct via the builder pattern

Name Type Description Notes
limit int32 Count of requested entities
offset int32 Offset
sort string Sort order. Default: desc
clientId string Client id
connectionId string Connection id
status string Channel status

Return type

[]ResponsesIbcChannel

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetIbcClient

ResponsesIbcClient GetIbcClient(ctx, id).Execute()

Get ibc client info

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/celenium-io/celenium-api-go"
)

func main() {
	id := "id_example" // string | IBC client id

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.IbcAPI.GetIbcClient(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `IbcAPI.GetIbcClient``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetIbcClient`: ResponsesIbcClient
	fmt.Fprintf(os.Stdout, "Response from `IbcAPI.GetIbcClient`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string IBC client id

Other Parameters

Other parameters are passed through a pointer to a apiGetIbcClientRequest struct via the builder pattern

Name Type Description Notes

Return type

ResponsesIbcClient

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetIbcClients

[]ResponsesIbcClient GetIbcClients(ctx).Limit(limit).Offset(offset).Sort(sort).ChainId(chainId).Creator(creator).Execute()

Get ibc clients info

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/celenium-io/celenium-api-go"
)

func main() {
	limit := int32(56) // int32 | Count of requested entities (optional)
	offset := int32(56) // int32 | Offset (optional)
	sort := "sort_example" // string | Sort order. Default: desc (optional)
	chainId := "chainId_example" // string | Chain id (optional)
	creator := "creator_example" // string | Creator address (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.IbcAPI.GetIbcClients(context.Background()).Limit(limit).Offset(offset).Sort(sort).ChainId(chainId).Creator(creator).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `IbcAPI.GetIbcClients``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetIbcClients`: []ResponsesIbcClient
	fmt.Fprintf(os.Stdout, "Response from `IbcAPI.GetIbcClients`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetIbcClientsRequest struct via the builder pattern

Name Type Description Notes
limit int32 Count of requested entities
offset int32 Offset
sort string Sort order. Default: desc
chainId string Chain id
creator string Creator address

Return type

[]ResponsesIbcClient

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetIbcConn

ResponsesIbcConnection GetIbcConn(ctx, id).Execute()

Get ibc connection info

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/celenium-io/celenium-api-go"
)

func main() {
	id := "id_example" // string | IBC connection id

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.IbcAPI.GetIbcConn(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `IbcAPI.GetIbcConn``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetIbcConn`: ResponsesIbcConnection
	fmt.Fprintf(os.Stdout, "Response from `IbcAPI.GetIbcConn`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string IBC connection id

Other Parameters

Other parameters are passed through a pointer to a apiGetIbcConnRequest struct via the builder pattern

Name Type Description Notes

Return type

ResponsesIbcConnection

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetIbcConns

[]ResponsesIbcConnection GetIbcConns(ctx).Limit(limit).Offset(offset).Sort(sort).ClientId(clientId).Execute()

Get ibc connections info

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/celenium-io/celenium-api-go"
)

func main() {
	limit := int32(56) // int32 | Count of requested entities (optional)
	offset := int32(56) // int32 | Offset (optional)
	sort := "sort_example" // string | Sort order. Default: desc (optional)
	clientId := "clientId_example" // string | Client id (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.IbcAPI.GetIbcConns(context.Background()).Limit(limit).Offset(offset).Sort(sort).ClientId(clientId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `IbcAPI.GetIbcConns``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetIbcConns`: []ResponsesIbcConnection
	fmt.Fprintf(os.Stdout, "Response from `IbcAPI.GetIbcConns`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetIbcConnsRequest struct via the builder pattern

Name Type Description Notes
limit int32 Count of requested entities
offset int32 Offset
sort string Sort order. Default: desc
clientId string Client id

Return type

[]ResponsesIbcConnection

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetIbcRelayers

[]ResponsesRelayer GetIbcRelayers(ctx).Execute()

List ibc relayers

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/celenium-io/celenium-api-go"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.IbcAPI.GetIbcRelayers(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `IbcAPI.GetIbcRelayers``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetIbcRelayers`: []ResponsesRelayer
	fmt.Fprintf(os.Stdout, "Response from `IbcAPI.GetIbcRelayers`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetIbcRelayersRequest struct via the builder pattern

Return type

[]ResponsesRelayer

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetIbcTransfer

ResponsesIbcTransfer GetIbcTransfer(ctx, id).Execute()

Get transfer by id

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/celenium-io/celenium-api-go"
)

func main() {
	id := int32(56) // int32 | Internal identity

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.IbcAPI.GetIbcTransfer(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `IbcAPI.GetIbcTransfer``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetIbcTransfer`: ResponsesIbcTransfer
	fmt.Fprintf(os.Stdout, "Response from `IbcAPI.GetIbcTransfer`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32 Internal identity

Other Parameters

Other parameters are passed through a pointer to a apiGetIbcTransferRequest struct via the builder pattern

Name Type Description Notes

Return type

ResponsesIbcTransfer

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetIbcTransfers

[]ResponsesIbcTransfer GetIbcTransfers(ctx).Limit(limit).Offset(offset).Sort(sort).ChannelId(channelId).ChainId(chainId).Receiver(receiver).Sender(sender).Address(address).Hash(hash).Execute()

Get ibc transfers info

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/celenium-io/celenium-api-go"
)

func main() {
	limit := int32(56) // int32 | Count of requested entities (optional)
	offset := int32(56) // int32 | Offset (optional)
	sort := "sort_example" // string | Sort order. Default: desc (optional)
	channelId := "channelId_example" // string | Channel id (optional)
	chainId := "chainId_example" // string | Chain id (optional)
	receiver := "receiver_example" // string | Receiver address (optional)
	sender := "sender_example" // string | Sender address (optional)
	address := "address_example" // string | Address: receiver or sender (optional)
	hash := "hash_example" // string | Transaction hash in hexadecimal (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.IbcAPI.GetIbcTransfers(context.Background()).Limit(limit).Offset(offset).Sort(sort).ChannelId(channelId).ChainId(chainId).Receiver(receiver).Sender(sender).Address(address).Hash(hash).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `IbcAPI.GetIbcTransfers``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetIbcTransfers`: []ResponsesIbcTransfer
	fmt.Fprintf(os.Stdout, "Response from `IbcAPI.GetIbcTransfers`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetIbcTransfersRequest struct via the builder pattern

Name Type Description Notes
limit int32 Count of requested entities
offset int32 Offset
sort string Sort order. Default: desc
channelId string Channel id
chainId string Chain id
receiver string Receiver address
sender string Sender address
address string Address: receiver or sender
hash string Transaction hash in hexadecimal

Return type

[]ResponsesIbcTransfer

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]