# README
Go API client for goqedit
This SDK provides a programmatic way for interacting with QEDIT's Asset Transfer API. The specification definition file is publicly available in this repository.
Overview
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: 1.7.2
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://github.com/QED-it/asset_transfers_dev_guide/
Installation
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional
Put the package under your project folder and add the following in import:
import "./goqedit"
Documentation for API Endpoints
All URIs are relative to http://localhost:12052
Class | Method | HTTP request | Description |
---|---|---|---|
AnalyticsApi | AnalyticsGetNetworkActivityPost | Post /analytics/get_network_activity | Get details on past blocks either by order using start_index and number_of_results or by the tx_hashes of the transactions |
AnalyticsApi | AnalyticsGetSyncStatusPost | Post /analytics/get_sync_status | Get blockchain sync status information |
AttachmentApi | AttachmentAddToGroupPost | Post /attachment/add_to_group | Add a new member to a group |
AttachmentApi | AttachmentCreateGroupPost | Post /attachment/create_group | Create a new group |
AttachmentApi | AttachmentDownloadPost | Post /attachment/download | Download an Attachment |
AttachmentApi | AttachmentGetGroupsPost | Post /attachment/get_groups | List the Groups the Wallet has access to |
AttachmentApi | AttachmentLeaveGroupPost | Post /attachment/leave_group | Removes an owned Wallet from a Group |
AttachmentApi | AttachmentListPost | Post /attachment/list | Lists available Attachments |
AttachmentApi | AttachmentUploadPost | Post /attachment/upload | Upload an Attachment and share it with a Group |
HealthApi | HealthPost | Post /health | Perform a healthcheck of the node and its dependent services |
NodeApi | NodeApproveTaskPost | Post /node/approve_task | Approve task with pending incoming transaction [async call] |
NodeApi | NodeCancelTaskPost | Post /node/cancel_task | Cancel task with pending incoming transaction both incoming and outgoing [async call] |
NodeApi | NodeDeleteWalletPost | Post /node/delete_wallet | Delete a Wallet [async call] |
NodeApi | NodeExportAuditorAccessWalletPost | Post /node/export_auditor_access_wallet | Export viewing credentials for a Wallet |
NodeApi | NodeExportWalletPost | Post /node/export_wallet | Export wallet secret key |
NodeApi | NodeGenerateWalletPost | Post /node/generate_wallet | Generate a new Wallet |
NodeApi | NodeGetAllWalletsPost | Post /node/get_all_wallets | Get all wallet IDs |
NodeApi | NodeGetNotificationsPost | Post /node/get_notifications | Get notifications |
NodeApi | NodeGetRulesPost | Post /node/get_rules | Get network governance Rules |
NodeApi | NodeGetTaskStatusPost | Post /node/get_task_status | Get a specific task (by ID) |
NodeApi | NodeGetTasksPost | Post /node/get_tasks | Get a (potentially) filtered list of all Tasks |
NodeApi | NodeImportAuditorAccessWalletPost | Post /node/import_auditor_access_wallet | Import viewing credentials for a Wallet [async call] |
NodeApi | NodeImportWalletPost | Post /node/import_wallet | Import Wallet from a known secret key and authorization [async call] |
WalletApi | WalletCreateRulePost | Post /wallet/create_rule | Create a new Rule in the network [async call] |
WalletApi | WalletDeleteRulePost | Post /wallet/delete_rule | Delete an existing Rule from the network [async call] |
WalletApi | WalletGetActivityPost | Post /wallet/get_activity | Get wallet activity (transactions) |
WalletApi | WalletGetBalancesPost | Post /wallet/get_balances | Get wallets balances |
WalletApi | WalletGetNewAddressPost | Post /wallet/get_new_address | Get a new address from a given diversifier or generate randomly |
WalletApi | WalletGetPublicKeyPost | Post /wallet/get_public_key | Get wallet public key |
WalletApi | WalletIssueAssetPost | Post /wallet/issue_asset | Issue assets [async call] |
WalletApi | WalletShareViewingPermissionPost | Post /wallet/share_viewing_permission | Share the viewing credentials for a given Wallet |
WalletApi | WalletTransferAssetPost | Post /wallet/transfer_asset | Transfer assets [async call] |
Documentation For Models
- AddToGroupRequest
- AddToGroupResponse
- AnalyticIssueWalletTx
- AnalyticRuleWalletTx
- AnalyticTransaction
- AnalyticTransferWalletTx
- AnalyticWalletMetadata
- AnalyticWalletTx
- AnalyticsConfidentialIssuanceDescription
- AnalyticsIssueTx
- AnalyticsMultiTransferTx
- AnalyticsOutput
- AnalyticsOutputDescription
- AnalyticsPublicIssuanceDescription
- AnalyticsRuleDefinition
- AnalyticsRuleTx
- AnalyticsRuleWalletDefinition
- AnalyticsSpendDescription
- AnalyticsTransferTx
- AnalyticsTxMetadata
- AnalyticsTxType
- AsyncTaskCreatedResponse
- AttachmentBody
- AttachmentHeader
- BalanceForAsset
- CreateGroupRequest
- CreateGroupResponse
- CreateRuleRequest
- DeleteRuleRequest
- DeleteWalletRequest
- DownloadAttachmentRequest
- DownloadAttachmentResponse
- EmptyContent
- ErrorResponse
- ExportAuditorAccessWalletRequest
- ExportAuditorAccessWalletResponse
- ExportWalletRequest
- ExportWalletResponse
- GenerateWalletRequest
- GetAllWalletsResponse
- GetGroupsRequest
- GetGroupsResponse
- GetNetworkActivityRequest
- GetNetworkActivityResponse
- GetNewAddressRequest
- GetNewAddressResponse
- GetNotificationsRequest
- GetNotificationsResponse
- GetPublicKeyRequest
- GetPublicKeyResponse
- GetRulesResponse
- GetSyncStatusResponse
- GetTaskStatusRequest
- GetTaskStatusResponse
- GetTasksRequest
- GetTasksResponse
- GetWalletActivityRequest
- GetWalletActivityResponse
- GetWalletBalanceRequest
- GetWalletBalanceResponse
- GroupInformation
- HealthcheckResponse
- HealthcheckResponseItem
- ImportAuditorAccessWalletRequest
- ImportWalletRequest
- IssueAssetRequest
- LeaveGroupRequest
- LeaveGroupResponse
- ListAttachmentsRequest
- ListAttachmentsResponse
- Notification
- NotificationType
- OrderEnum
- Result
- Rule
- ShareWalletViewingPermissionRequest
- ShareWalletViewingPermissionResponse
- TaskActionRequest
- TaskData
- TaskState
- TaskType
- TransferAssetRequest
- UploadAttachmentRequest
- UploadAttachmentResponse
Documentation For Authorization
ApiKeyAuth
- Type: API key
Example
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)
Author
# Packages
No description provided by the author
# Functions
CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
No description provided by the author
No description provided by the author
No description provided by the author
# Constants
List of TaskType.
List of OrderEnum.
List of Result.
List of TaskType.
List of NotificationType.
List of TaskState.
List of TaskState.
List of TaskState.
List of TaskState.
List of TaskType.
List of OrderEnum.
List of NotificationType.
List of Result.
List of TaskState.
List of TaskType.
List of Result.
List of TaskState.
List of TaskType.
List of AnalyticsTxType.
List of TaskType.
List of TaskType.
List of Result.
List of TaskState.
List of AnalyticsTxType.
List of Result.
List of TaskState.
List of AnalyticsTxType.
List of TaskType.
List of TaskState.
List of TaskState.
# Variables
ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
# Structs
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The details and Proof attached to a confidential Issuance; null if the Issuance was public.
The data of a particular Issuance transaction.
The data of a particular Transfer transaction; a single such transaction may contain multiple Transfers.
No description provided by the author
No description provided by the author
Describes what Asset Type and amount were issued; null if the Issuance was confidential.
No description provided by the author
The data of a particular Rule changing transaction.
No description provided by the author
No description provided by the author
The data of a single Transfer within a Transfer transaction.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A single retrieved transaction.
APIClient manages communication with the QEDIT - Asset Transfers API v1.7.2 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
No description provided by the author
The payload of the Attachment.
The metadata of a single Attachment, without the potentially long content.
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GenericOpenAPIError Provides access to the body, error and model on returned errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The request body determines which filters to apply to the notifications.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A notification including some metadata and a content field whose type depends on the type of notification.
No description provided by the author
No description provided by the author
No description provided by the author
To approve or cancel a task, the user should include the task id and authorization of the wallet related to this task.
An object that includes additional request details.
No description provided by the author
No description provided by the author
No description provided by the author
# Type aliases
No description provided by the author
AnalyticsTxType : Type of transaction.
No description provided by the author
No description provided by the author
No description provided by the author
NotificationType : The type of notification.
OrderEnum : Order of results to fetch (either ascending or descending); ordering is chronological where the time is set to when the retrieved object was created.
Result : The current result (status) of the Task.
TaskState : A fine-grained status of the node's inner state.
TaskType : Task type.
No description provided by the author