client

Documentation

Index

• Constants
• func DefaultClient(cfg *Config) (kaminarigosdk.Interface, error)
• type Client
  • func (client *Client) ConvertLnUrlInvoiceToLND(req *kaminarigosdk.ConvertLnUrlInvoiceToLNDRequest) (*kaminarigosdk.ConvertLnUrlInvoiceToLNDResponse, error)
  • func (client *Client) CreateLightningInvoice(req *kaminarigosdk.CreateInvoiceRequest) (*kaminarigosdk.CreateLightningInvoiceResponse, error)
  • func (client *Client) CreateOnChainInvoice(req *kaminarigosdk.CreateInvoiceRequest) (string, error)
  • func (client *Client) EstimateOnChainTx(req *kaminarigosdk.EstimateOnChainTxRequest) (*kaminarigosdk.EstimateOnChainTxResponse, error)
  • func (client *Client) GetBalance(nonce string) (*kaminarigosdk.Balance, error)
  • func (client *Client) GetLightningAddress(nonce string) (*kaminarigosdk.GetLightningAddrResponse, error)
  • func (client *Client) GetLightningAddressForMerchant(req *kaminarigosdk.GetLightningAddrForMerchantRequest) (*kaminarigosdk.GetLightningAddrForMerchantResponse, error)
  • func (client *Client) GetLightningInvoice(req *kaminarigosdk.GetLightningInvoiceRequest) (*kaminarigosdk.GetLightningInvoiceResponse, error)
  • func (client *Client) GetLightningTransaction(req *kaminarigosdk.GetLightningTransactionRequest) (*kaminarigosdk.GetLightningTransactionResponse, error)
  • func (client *Client) GetOnChainInvoice(req *kaminarigosdk.GetOnChainInvoiceRequest) (*kaminarigosdk.GetOnChainInvoiceResponse, error)
  • func (client *Client) GetOnChainTransaction(req *kaminarigosdk.GetOnChainTransactionRequest) (*kaminarigosdk.GetOnChainTransactionResponse, error)
  • func (client *Client) GetSignature(rawUrl string, nonce string, body []byte) (string, error)
  • func (client *Client) GetStatistic(req *kaminarigosdk.GetStatisticRequest) (*kaminarigosdk.GetStatisticResponse, error)
  • func (client *Client) SendLightningPayment(req *kaminarigosdk.SendLightningPaymentRequest) error
  • func (client *Client) SendOnChainPayment(req *kaminarigosdk.SendOnChainPaymentRequest) error
  • func (client *Client) VerifyWebhookSignature(req *kaminarigosdk.VerifyWebhookSignatureRequest) (*kaminarigosdk.VerifyWebhookSignatureResponse, error)
• type Config

Constants

const ApiSignatureHeader = "X-kaminari-api-signature"

Functions

func DefaultClient

func DefaultClient(cfg *Config) (kaminarigosdk.Interface, error)

Types

type Client

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

func (*Client) ConvertLnUrlInvoiceToLND

func (client *Client) ConvertLnUrlInvoiceToLND(req *kaminarigosdk.ConvertLnUrlInvoiceToLNDRequest) (*kaminarigosdk.ConvertLnUrlInvoiceToLNDResponse, error)

func (*Client) CreateLightningInvoice

func (client *Client) CreateLightningInvoice(req *kaminarigosdk.CreateInvoiceRequest) (*kaminarigosdk.CreateLightningInvoiceResponse, error)

func (*Client) CreateOnChainInvoice

func (client *Client) CreateOnChainInvoice(req *kaminarigosdk.CreateInvoiceRequest) (string, error)

func (*Client) EstimateOnChainTx

func (client *Client) EstimateOnChainTx(req *kaminarigosdk.EstimateOnChainTxRequest) (*kaminarigosdk.EstimateOnChainTxResponse, error)

EstimateOnChainTx estimates fee for on-chain tx, estimated fee returns in satoshi. Provided amount should be in satoshi(1 BTC = 100_000_000 sats).

func (*Client) GetBalance

func (client *Client) GetBalance(nonce string) (*kaminarigosdk.Balance, error)

func (*Client) GetLightningAddress

func (client *Client) GetLightningAddress(nonce string) (*kaminarigosdk.GetLightningAddrResponse, error)

func (*Client) GetLightningAddressForMerchant

func (client *Client) GetLightningAddressForMerchant(req *kaminarigosdk.GetLightningAddrForMerchantRequest) (*kaminarigosdk.GetLightningAddrForMerchantResponse, error)

func (*Client) GetLightningInvoice

func (client *Client) GetLightningInvoice(req *kaminarigosdk.GetLightningInvoiceRequest) (*kaminarigosdk.GetLightningInvoiceResponse, error)

func (*Client) GetLightningTransaction

func (client *Client) GetLightningTransaction(req *kaminarigosdk.GetLightningTransactionRequest) (*kaminarigosdk.GetLightningTransactionResponse, error)

func (*Client) GetOnChainInvoice

func (client *Client) GetOnChainInvoice(req *kaminarigosdk.GetOnChainInvoiceRequest) (*kaminarigosdk.GetOnChainInvoiceResponse, error)

func (*Client) GetOnChainTransaction

func (client *Client) GetOnChainTransaction(req *kaminarigosdk.GetOnChainTransactionRequest) (*kaminarigosdk.GetOnChainTransactionResponse, error)

func (*Client) GetSignature

func (client *Client) GetSignature(rawUrl string, nonce string, body []byte) (string, error)

GetSignature produces signature for API authorization.

func (*Client) GetStatistic

func (client *Client) GetStatistic(req *kaminarigosdk.GetStatisticRequest) (*kaminarigosdk.GetStatisticResponse, error)

func (*Client) SendLightningPayment

func (client *Client) SendLightningPayment(req *kaminarigosdk.SendLightningPaymentRequest) error

func (*Client) SendOnChainPayment

func (client *Client) SendOnChainPayment(req *kaminarigosdk.SendOnChainPaymentRequest) error

func (*Client) VerifyWebhookSignature

func (client *Client) VerifyWebhookSignature(req *kaminarigosdk.VerifyWebhookSignatureRequest) (*kaminarigosdk.VerifyWebhookSignatureResponse, error)

type Config

type Config struct {
	ApiKey    string
	SecretKey string
	ApiUrl    string
}