kmdapi

package
v0.3.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 26, 2025 License: AGPL-3.0 Imports: 3 Imported by: 0

Documentation

Overview

Code generated by bundle_swagger_json.sh, along with swagger.json. DO NOT EDIT.

Index

Constants

This section is empty.

Variables

View Source 
var SwaggerSpecJSON string

SwaggerSpecJSON is autogenerated from swagger.json, and bundled in with a script on build through a package init() function.

Functions

This section is empty.

Types

type APIV1DELETEKeyRequest 

type APIV1DELETEKeyRequest struct {
	WalletHandleToken string `json:"wallet_handle_token"`
	Address           string `json:"address"`
	WalletPassword    string `json:"wallet_password"`
	// contains filtered or unexported fields
}

APIV1DELETEKeyRequest is the request for `DELETE /v1/key`

swagger:model DeleteKeyRequest

type APIV1DELETEKeyResponse 

type APIV1DELETEKeyResponse struct {
	APIV1ResponseEnvelope
}

APIV1DELETEKeyResponse is the response to `DELETE /v1/key` friendly:DeleteKeyResponse

type APIV1DELETEMultisigRequest 

type APIV1DELETEMultisigRequest struct {
	WalletHandleToken string `json:"wallet_handle_token"`
	Address           string `json:"address"`
	WalletPassword    string `json:"wallet_password"`
	// contains filtered or unexported fields
}

APIV1DELETEMultisigRequest is the request for `DELETE /v1/multisig`

swagger:model DeleteMultisigRequest

type APIV1DELETEMultisigResponse 

type APIV1DELETEMultisigResponse struct {
	APIV1ResponseEnvelope
}

APIV1DELETEMultisigResponse is the response to POST /v1/multisig/delete` friendly:DeleteMultisigResponse

type APIV1GETWalletsRequest 

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

APIV1GETWalletsRequest is the request for `GET /v1/wallets`

swagger:model ListWalletsRequest

type APIV1GETWalletsResponse 

type APIV1GETWalletsResponse struct {
	APIV1ResponseEnvelope
	Wallets []APIV1Wallet `json:"wallets"`
}

APIV1GETWalletsResponse is the response to `GET /v1/wallets` friendly:ListWalletsResponse

type APIV1MasterDerivationKey 

type APIV1MasterDerivationKey = crypto.MasterDerivationKey

APIV1MasterDerivationKey is a swagger annotated alias of crypto.MasterDerivationKey swagger:strfmt byte

type APIV1POSTKeyExportRequest 

type APIV1POSTKeyExportRequest struct {
	WalletHandleToken string `json:"wallet_handle_token"`
	Address           string `json:"address"`
	WalletPassword    string `json:"wallet_password"`
	// contains filtered or unexported fields
}

APIV1POSTKeyExportRequest is the request for `POST /v1/key/export`

swagger:model ExportKeyRequest

type APIV1POSTKeyExportResponse 

type APIV1POSTKeyExportResponse struct {
	APIV1ResponseEnvelope
	PrivateKey APIV1PrivateKey `json:"private_key"`
}

APIV1POSTKeyExportResponse is the response to `POST /v1/key/export` friendly:ExportKeyResponse

type APIV1POSTKeyImportRequest 

type APIV1POSTKeyImportRequest struct {
	WalletHandleToken string            `json:"wallet_handle_token"`
	PrivateKey        crypto.PrivateKey `json:"private_key"`
	// contains filtered or unexported fields
}

APIV1POSTKeyImportRequest is the request for `POST /v1/key/import`

swagger:model ImportKeyRequest

type APIV1POSTKeyImportResponse 

type APIV1POSTKeyImportResponse struct {
	APIV1ResponseEnvelope
	Address string `json:"address"`
}

APIV1POSTKeyImportResponse is the response to `POST /v1/key/import` friendly:ImportKeyResponse

type APIV1POSTKeyListRequest 

type APIV1POSTKeyListRequest struct {
	WalletHandleToken string `json:"wallet_handle_token"`
	// contains filtered or unexported fields
}

APIV1POSTKeyListRequest is the request for `POST /v1/key/list`

swagger:model ListKeysRequest

type APIV1POSTKeyListResponse 

type APIV1POSTKeyListResponse struct {
	APIV1ResponseEnvelope
	Addresses []string `json:"addresses"`
}

APIV1POSTKeyListResponse is the response to `POST /v1/key/list` friendly:ListKeysResponse

type APIV1POSTKeyRequest 

type APIV1POSTKeyRequest struct {
	WalletHandleToken string `json:"wallet_handle_token"`
	DisplayMnemonic   bool   `json:"display_mnemonic"`
	// contains filtered or unexported fields
}

APIV1POSTKeyRequest is the request for `POST /v1/key`

swagger:model GenerateKeyRequest

type APIV1POSTKeyResponse 

type APIV1POSTKeyResponse struct {
	APIV1ResponseEnvelope
	Address string `json:"address"`
}

APIV1POSTKeyResponse is the response to `POST /v1/key` friendly:GenerateKeyResponse

type APIV1POSTMasterKeyExportRequest 

type APIV1POSTMasterKeyExportRequest struct {
	WalletHandleToken string `json:"wallet_handle_token"`
	WalletPassword    string `json:"wallet_password"`
	// contains filtered or unexported fields
}

APIV1POSTMasterKeyExportRequest is the request for `POST /v1/master-key/export`

swagger:model ExportMasterKeyRequest

type APIV1POSTMasterKeyExportResponse 

type APIV1POSTMasterKeyExportResponse struct {
	APIV1ResponseEnvelope
	MasterDerivationKey APIV1MasterDerivationKey `json:"master_derivation_key"`
}

APIV1POSTMasterKeyExportResponse is the response to `POST /v1/master-key/export` friendly:ExportMasterKeyResponse

type APIV1POSTMultisigExportRequest 

type APIV1POSTMultisigExportRequest struct {
	WalletHandleToken string `json:"wallet_handle_token"`
	Address           string `json:"address"`
	// contains filtered or unexported fields
}

APIV1POSTMultisigExportRequest is the request for `POST /v1/multisig/export`

swagger:model ExportMultisigRequest

type APIV1POSTMultisigExportResponse 

type APIV1POSTMultisigExportResponse struct {
	APIV1ResponseEnvelope
	Version   uint8            `json:"multisig_version"`
	Threshold uint8            `json:"threshold"`
	PKs       []APIV1PublicKey `json:"pks"`
}

APIV1POSTMultisigExportResponse is the response to `POST /v1/multisig/export` friendly:ExportMultisigResponse

type APIV1POSTMultisigImportRequest 

type APIV1POSTMultisigImportRequest struct {
	WalletHandleToken string             `json:"wallet_handle_token"`
	Version           uint8              `json:"multisig_version"`
	Threshold         uint8              `json:"threshold"`
	PKs               []crypto.PublicKey `json:"pks"`
	// contains filtered or unexported fields
}

APIV1POSTMultisigImportRequest is the request for `POST /v1/multisig/import`

swagger:model ImportMultisigRequest

type APIV1POSTMultisigImportResponse 

type APIV1POSTMultisigImportResponse struct {
	APIV1ResponseEnvelope
	Address string `json:"address"`
}

APIV1POSTMultisigImportResponse is the response to `POST /v1/multisig/import` friendly:ImportMultisigResponse

type APIV1POSTMultisigListRequest 

type APIV1POSTMultisigListRequest struct {
	WalletHandleToken string `json:"wallet_handle_token"`
	// contains filtered or unexported fields
}

APIV1POSTMultisigListRequest is the request for `POST /v1/multisig/list`

swagger:model ListMultisigRequest

type APIV1POSTMultisigListResponse 

type APIV1POSTMultisigListResponse struct {
	APIV1ResponseEnvelope
	Addresses []string `json:"addresses"`
}

APIV1POSTMultisigListResponse is the response to `POST /v1/multisig/list` friendly:ListMultisigResponse

type APIV1POSTMultisigProgramSignRequest 

type APIV1POSTMultisigProgramSignRequest struct {
	WalletHandleToken string `json:"wallet_handle_token"`
	Address           string `json:"address"`
	// swagger:strfmt byte
	Program        []byte             `json:"data"`
	PublicKey      crypto.PublicKey   `json:"public_key"`
	PartialMsig    crypto.MultisigSig `json:"partial_multisig"`
	WalletPassword string             `json:"wallet_password"`
	// contains filtered or unexported fields
}

APIV1POSTMultisigProgramSignRequest is the request for `POST /v1/multisig/signprogram`

swagger:model SignProgramMultisigRequest

type APIV1POSTMultisigProgramSignResponse 

type APIV1POSTMultisigProgramSignResponse struct {
	APIV1ResponseEnvelope

	// swagger:strfmt byte
	Multisig []byte `json:"multisig"`
}

APIV1POSTMultisigProgramSignResponse is the response to `POST /v1/multisig/signdata` friendly:SignProgramMultisigResponse

type APIV1POSTMultisigTransactionSignRequest 

type APIV1POSTMultisigTransactionSignRequest struct {
	WalletHandleToken string `json:"wallet_handle_token"`
	// swagger:strfmt byte
	Transaction    []byte             `json:"transaction"`
	PublicKey      crypto.PublicKey   `json:"public_key"`
	PartialMsig    crypto.MultisigSig `json:"partial_multisig"`
	WalletPassword string             `json:"wallet_password"`
	AuthAddr       crypto.Digest      `json:"signer"`
	// contains filtered or unexported fields
}

APIV1POSTMultisigTransactionSignRequest is the request for `POST /v1/multisig/sign`

swagger:model SignMultisigRequest

type APIV1POSTMultisigTransactionSignResponse 

type APIV1POSTMultisigTransactionSignResponse struct {
	APIV1ResponseEnvelope

	// swagger:strfmt byte
	Multisig []byte `json:"multisig"`
}

APIV1POSTMultisigTransactionSignResponse is the response to `POST /v1/multisig/sign` friendly:SignMultisigResponse

type APIV1POSTProgramSignRequest 

type APIV1POSTProgramSignRequest struct {
	WalletHandleToken string `json:"wallet_handle_token"`
	Address           string `json:"address"`
	// swagger:strfmt byte
	Program        []byte `json:"data"`
	WalletPassword string `json:"wallet_password"`
	// contains filtered or unexported fields
}

APIV1POSTProgramSignRequest is the request for `POST /v1/program/sign`

swagger:model SignProgramRequest

type APIV1POSTProgramSignResponse 

type APIV1POSTProgramSignResponse struct {
	APIV1ResponseEnvelope

	// swagger:strfmt byte
	Signature []byte `json:"sig"`
}

APIV1POSTProgramSignResponse is the response to `POST /v1/data/sign` friendly:SignProgramResponse

type APIV1POSTTransactionSignRequest 

type APIV1POSTTransactionSignRequest struct {
	WalletHandleToken string `json:"wallet_handle_token"`
	// Base64 encoding of msgpack encoding of a `Transaction` object
	// Note: SDK and goal usually generate `SignedTxn` objects
	//   in that case, the field `txn` / `Transaction` of the
	//   generated `SignedTxn` object needs to be used
	//
	// swagger:strfmt byte
	Transaction    []byte           `json:"transaction"`
	PublicKey      crypto.PublicKey `json:"public_key"`
	WalletPassword string           `json:"wallet_password"`
	// contains filtered or unexported fields
}

APIV1POSTTransactionSignRequest is the request for `POST /v1/transaction/sign`

swagger:model SignTransactionRequest

type APIV1POSTTransactionSignResponse 

type APIV1POSTTransactionSignResponse struct {
	APIV1ResponseEnvelope

	// swagger:strfmt byte
	SignedTransaction []byte `json:"signed_transaction"`
}

APIV1POSTTransactionSignResponse is the response to `POST /v1/transaction/sign` friendly:SignTransactionResponse

type APIV1POSTWalletInfoRequest 

type APIV1POSTWalletInfoRequest struct {
	WalletHandleToken string `json:"wallet_handle_token"`
	// contains filtered or unexported fields
}

APIV1POSTWalletInfoRequest is the request for `POST /v1/wallet/info`

swagger:model WalletInfoRequest

type APIV1POSTWalletInfoResponse 

type APIV1POSTWalletInfoResponse struct {
	APIV1ResponseEnvelope
	WalletHandle APIV1WalletHandle `json:"wallet_handle"`
}

APIV1POSTWalletInfoResponse is the response to `POST /v1/wallet/info` friendly:WalletInfoResponse

type APIV1POSTWalletInitRequest 

type APIV1POSTWalletInitRequest struct {
	WalletID       string `json:"wallet_id"`
	WalletPassword string `json:"wallet_password"`
	// contains filtered or unexported fields
}

APIV1POSTWalletInitRequest is the request for `POST /v1/wallet/init`

swagger:model InitWalletHandleTokenRequest

type APIV1POSTWalletInitResponse 

type APIV1POSTWalletInitResponse struct {
	APIV1ResponseEnvelope
	WalletHandleToken string `json:"wallet_handle_token"`
}

APIV1POSTWalletInitResponse is the response to `POST /v1/wallet/init` friendly:InitWalletHandleTokenResponse

type APIV1POSTWalletReleaseRequest 

type APIV1POSTWalletReleaseRequest struct {
	WalletHandleToken string `json:"wallet_handle_token"`
	// contains filtered or unexported fields
}

APIV1POSTWalletReleaseRequest is the request for `POST /v1/wallet/release`

swagger:model ReleaseWalletHandleTokenRequest

type APIV1POSTWalletReleaseResponse 

type APIV1POSTWalletReleaseResponse struct {
	APIV1ResponseEnvelope
}

APIV1POSTWalletReleaseResponse is the response to `POST /v1/wallet/release` friendly:ReleaseWalletHandleTokenResponse

type APIV1POSTWalletRenameRequest 

type APIV1POSTWalletRenameRequest struct {
	WalletID       string `json:"wallet_id"`
	WalletPassword string `json:"wallet_password"`
	NewWalletName  string `json:"wallet_name"`
	// contains filtered or unexported fields
}

APIV1POSTWalletRenameRequest is the request for `POST /v1/wallet/rename`

swagger:model RenameWalletRequest

type APIV1POSTWalletRenameResponse 

type APIV1POSTWalletRenameResponse struct {
	APIV1ResponseEnvelope
	Wallet APIV1Wallet `json:"wallet"`
}

APIV1POSTWalletRenameResponse is the response to `POST /v1/wallet/rename` friendly:RenameWalletResponse

type APIV1POSTWalletRenewRequest 

type APIV1POSTWalletRenewRequest struct {
	WalletHandleToken string `json:"wallet_handle_token"`
	// contains filtered or unexported fields
}

APIV1POSTWalletRenewRequest is the request for `POST /v1/wallet/renew`

swagger:model RenewWalletHandleTokenRequest

type APIV1POSTWalletRenewResponse 

type APIV1POSTWalletRenewResponse struct {
	APIV1ResponseEnvelope
	WalletHandle APIV1WalletHandle `json:"wallet_handle"`
}

APIV1POSTWalletRenewResponse is the response to `POST /v1/wallet/renew` friendly:RenewWalletHandleTokenResponse

type APIV1POSTWalletRequest 

type APIV1POSTWalletRequest struct {
	WalletName          string                   `json:"wallet_name"`
	WalletDriverName    string                   `json:"wallet_driver_name"`
	WalletPassword      string                   `json:"wallet_password"`
	MasterDerivationKey APIV1MasterDerivationKey `json:"master_derivation_key"`
	// contains filtered or unexported fields
}

APIV1POSTWalletRequest is the request for `POST /v1/wallet`

swagger:model CreateWalletRequest

type APIV1POSTWalletResponse 

type APIV1POSTWalletResponse struct {
	APIV1ResponseEnvelope
	Wallet APIV1Wallet `json:"wallet"`
}

APIV1POSTWalletResponse is the response to `POST /v1/wallet` friendly:CreateWalletResponse

type APIV1PrivateKey 

type APIV1PrivateKey = crypto.PrivateKey

APIV1PrivateKey is a swagger annotated alias of crypto.privateKey swagger:strfmt byte

type APIV1PublicKey 

type APIV1PublicKey = crypto.PublicKey

APIV1PublicKey is a swagger annotated alias of crypto.PublicKey swagger:strfmt byte

type APIV1Request 

type APIV1Request interface{} // we need to tell swagger to ignore due to bug (go-swagger/issues/1436)

APIV1Request is the interface that all API V1 requests must satisfy

swagger:ignore

type APIV1Response 

type APIV1Response interface {
	GetError() error
}

APIV1Response is the interface that all API V1 responses must satisfy

type APIV1ResponseEnvelope 

type APIV1ResponseEnvelope struct {
	Error   bool   `json:"error"`
	Message string `json:"message"`
	// contains filtered or unexported fields
}

APIV1ResponseEnvelope is a common envelope that all API V1 responses must embed

func (APIV1ResponseEnvelope) GetError 

func (r APIV1ResponseEnvelope) GetError() error

GetError allows responses that embed an APIV1ResponseEnvelope to satisfy the APIV1Response interface

type APIV1Wallet 

type APIV1Wallet struct {
	ID                    string            `json:"id"`
	Name                  string            `json:"name"`
	DriverName            string            `json:"driver_name"`
	DriverVersion         uint32            `json:"driver_version"`
	SupportsMnemonicUX    bool              `json:"mnemonic_ux"`
	SupportedTransactions []protocol.TxType `json:"supported_txs"`
}

APIV1Wallet is the API's representation of a wallet

type APIV1WalletHandle 

type APIV1WalletHandle struct {
	Wallet         APIV1Wallet `json:"wallet"`
	ExpiresSeconds int64       `json:"expires_seconds"`
}

APIV1WalletHandle includes the wallet the handle corresponds to and the number of number of seconds to expiration

type VersionsRequest 

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

VersionsRequest is the request for `GET /versions`

swagger:model VersionsRequest

type VersionsResponse 

type VersionsResponse struct {
	Versions []string `json:"versions"`
	// contains filtered or unexported fields
}

VersionsResponse is the response to `GET /versions` friendly:VersionsResponse

func (VersionsResponse) GetError 

func (r VersionsResponse) GetError() error

GetError allows VersionResponse to satisfy the APIV1Response interface, even though it can never return an error and is not versioned

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.