wallet

Documentation

Index

• func AddRemoteHandler(db *gorm.DB, request AddRemoteRequest) (*model.Wallet, *handler.Error)
• func AddWalletHandler(db *gorm.DB, datasetName string, wallet string) (*model.WalletAssignment, *handler.Error)
• func ImportHandler(db *gorm.DB, request ImportRequest) (*model.Wallet, *handler.Error)
• func ListHandler(db *gorm.DB) ([]model.Wallet, *handler.Error)
• func ListWalletHandler(db *gorm.DB, datasetName string) ([]model.Wallet, *handler.Error)
• func RemoveHandler(db *gorm.DB, address string) *handler.Error
• func RemoveWalletHandler(db *gorm.DB, datasetName string, wallet string) *handler.Error
• type AddRemoteRequest
• type ImportRequest

Functions

func AddRemoteHandler

func AddRemoteHandler(
	db *gorm.DB,
	request AddRemoteRequest,
) (*model.Wallet, *handler.Error)

AddRemoteHandler godoc @Summary Add a remote wallet @Tags Wallet @Accept json @Produce json @Param request body AddRemoteRequest true "Request body" @Success 200 {object} model.Wallet @Failure 400 {object} handler.HTTPError @Failure 500 {object} handler.HTTPError @Router /wallet/remote [post]

func AddWalletHandler

func AddWalletHandler(
	db *gorm.DB,
	datasetName string,
	wallet string,
) (*model.WalletAssignment, *handler.Error)

AddWalletHandler godoc @Summary Associate a new wallet with a dataset @Tags Wallet Association @Produce json @Accept json @Param datasetName path string true "Dataset name" @Param wallet path string true "Wallet Address" @Success 200 {object} model.WalletAssignment @Failure 400 {object} handler.HTTPError @Failure 500 {object} handler.HTTPError @Router /dataset/{datasetName}/wallet/{wallet} [post]

func ImportHandler

func ImportHandler(
	db *gorm.DB,
	request ImportRequest,
) (*model.Wallet, *handler.Error)

ImportHandler godoc @Summary Import a private key @Tags Wallet @Accept json @Produce json @Param request body ImportRequest true "Request body" @Success 200 {object} model.Wallet @Failure 400 {object} handler.HTTPError @Failure 500 {object} handler.HTTPError @Router /wallet [post]

func ListHandler

func ListHandler(
	db *gorm.DB,
) ([]model.Wallet, *handler.Error)

ListHandler godoc @Summary List all imported wallets @Tags Wallet @Produce json @Success 200 {array} model.Wallet @Failure 400 {object} handler.HTTPError @Failure 500 {object} handler.HTTPError @Router /wallet [get]

func ListWalletHandler

func ListWalletHandler(
	db *gorm.DB,
	datasetName string,
) ([]model.Wallet, *handler.Error)

ListWalletHandler godoc @Summary List all wallets of a dataset. @Tags Wallet @Produce json @Param datasetName path string true "Dataset name" @Success 200 {array} model.Wallet @Failure 400 {object} handler.HTTPError @Failure 500 {object} handler.HTTPError @Router /dataset/{datasetName}/wallet [get]

func RemoveHandler

func RemoveHandler(
	db *gorm.DB,
	address string,
) *handler.Error

RemoveHandler godoc @Summary Remove a wallet @Tags Wallet @Param address path string true "Address" @Success 204 @Failure 400 {object} handler.HTTPError @Failure 500 {object} handler.HTTPError @Router /wallet/{address} [delete]

func RemoveWalletHandler

func RemoveWalletHandler(
	db *gorm.DB,
	datasetName string,
	wallet string,
) *handler.Error

RemoveWalletHandler godoc @Summary Remove an associated wallet from a dataset @Tags Wallet @Param datasetName path string true "Dataset name" @Param wallet path string true "Wallet Address" @Success 204 @Failure 400 {object} handler.HTTPError @Failure 500 {object} handler.HTTPError @Router /dataset/{datasetName}/wallet/{wallet} [delete]

Types

type AddRemoteRequest

type AddRemoteRequest struct {
	Address    string `json:"address"`    // Address is the Filecoin full address of the wallet
	RemotePeer string `json:"remotePeer"` // RemotePeer is the remote peer ID of the wallet, for remote signing purpose
	LotusAPI   string `json:"lotusApi"   swaggerignore:"true"`
	LotusToken string `json:"lotusToken" swaggerignore:"true"`
}

type ImportRequest

type ImportRequest struct {
	PrivateKey string `json:"privateKey"` // This is the exported private key from lotus wallet export
	LotusAPI   string `json:"lotusApi"   swaggerignore:"true"`
	LotusToken string `json:"lotusToken" swaggerignore:"true"`
}