remotesigning

type DeriveKeyAndSignRequest ¶ added in v0.5.0

type DeriveKeyAndSignRequest struct {
	SigningJobs    []SigningJob
	BitcoinNetwork objects.BitcoinNetwork
}

A signing request asking for a key to be derived and used to sign a message.

func ParseDeriveAndSignRequest(webhook webhooks.WebhookEvent) (*DeriveKeyAndSignRequest, error)

func (r *DeriveKeyAndSignRequest) Type() objects.RemoteSigningSubEventType

type DeriveKeyAndSignResponse ¶ added in v0.5.0

type DeriveKeyAndSignResponse struct {
	Signatures []SignatureResponse
}

func HandleDeriveKeyAndSignRequest(request *DeriveKeyAndSignRequest, seedBytes []byte) (*DeriveKeyAndSignResponse, error)

func (r DeriveKeyAndSignResponse) GraphqlResponse() *GraphQLResponse

type DestinationValidator ¶ added in v0.16.0

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

A validator that checks that the outputs of a transaction pass restrictions for where we allow sending funds. This is used to ensure that when signing transactions spending L1 wallet funds, we are only sending funds to certain addresses.

func NewDestinationValidator(masterSeed []byte, validateForceClosureClaims bool) DestinationValidator

func (v DestinationValidator) ShouldSign(webhookEvent webhooks.WebhookEvent) bool

type ECDHRequest ¶ added in v0.5.0

type ECDHRequest struct {
	NodeId         string
	PeerPubKeyHex  string
	BitcoinNetwork objects.BitcoinNetwork
}

A signing request asking for a shared secret to be computed using Eliptic Curve Diffie-Hellman. The shared secret is computed using your node's identity private key and the peer's public key. This request is only for nodes created before 10/06/2023.

func ParseECDHRequest(webhook webhooks.WebhookEvent) (*ECDHRequest, error)

func (r *ECDHRequest) Type() objects.RemoteSigningSubEventType

type ECDHResponse ¶ added in v0.5.0

type ECDHResponse struct {
	NodeId          string
	SharedSecretHex string
}

func HandleEcdhRequest(request *ECDHRequest, seedBytes []byte) (*ECDHResponse, error)

func (r ECDHResponse) GraphqlResponse() *GraphQLResponse

type GetPerCommitmentPointRequest ¶ added in v0.5.0

type GetPerCommitmentPointRequest struct {
	ChannelId             string
	DerivationPath        string
	PerCommitmentPointIdx uint64
	NodeId                string
	BitcoinNetwork        objects.BitcoinNetwork
}

A signing request asking for a per-commitment point for a particular channel. The per-commitment point is the point on the secp256k1 curve for the commitment secret described in bolt 3.

func ParseGetPerCommitmentPointRequest(webhook webhooks.WebhookEvent) (*GetPerCommitmentPointRequest, error)

func (r *GetPerCommitmentPointRequest) Type() objects.RemoteSigningSubEventType

type GetPerCommitmentPointResponse ¶ added in v0.5.0

type GetPerCommitmentPointResponse struct {
	ChannelId             string
	PerCommitmentPointIdx uint64
	PerCommitmentPointHex string
}

func HandleGetPerCommitmentPointRequest(request *GetPerCommitmentPointRequest, seedBytes []byte) (*GetPerCommitmentPointResponse, error)

func (r GetPerCommitmentPointResponse) GraphqlResponse() *GraphQLResponse

type GraphQLResponse ¶ added in v0.5.0

type GraphQLResponse struct {
	Query       string
	Variables   map[string]interface{}
	OutputField string
}

type HashValidator ¶ added in v0.13.0

type HashValidator struct{}

func (v HashValidator) ShouldSign(webhookEvent webhooks.WebhookEvent) bool

type InvoicePaymentHashRequest ¶ added in v0.5.0

type InvoicePaymentHashRequest struct {
	InvoiceId      string
	BitcoinNetwork objects.BitcoinNetwork
}

A signing request asking for a payment hash. A payment hash is the hash of a payment preimage. The payment preimage is the secret that is revealed when a payment is made on the Lightning Network.

func ParseRequestInvoicePaymentHashRequest(webhook webhooks.WebhookEvent) (*InvoicePaymentHashRequest, error)

func (r *InvoicePaymentHashRequest) Type() objects.RemoteSigningSubEventType

type InvoicePaymentHashResponse ¶ added in v0.5.0

type InvoicePaymentHashResponse struct {
	InvoiceId      string
	PaymentHashHex string
	Nonce          *string
}

func HandleInvoicePaymentHashRequest(request *InvoicePaymentHashRequest, seedBytes []byte) (*InvoicePaymentHashResponse, error)

func (r InvoicePaymentHashResponse) GraphqlResponse() *GraphQLResponse

type MultiValidator ¶ added in v0.16.0

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

func NewMultiValidator(validators ...Validator) MultiValidator

func (v MultiValidator) ShouldSign(webhookEvent webhooks.WebhookEvent) bool

type PositiveValidator ¶

type PositiveValidator struct{}

func (v PositiveValidator) ShouldSign(webhook webhooks.WebhookEvent) bool

type ReleaseCounterpartyPerCommitmentSecretRequest ¶ added in v0.5.0

type ReleaseCounterpartyPerCommitmentSecretRequest struct {
	ChannelId              string
	PerCommitmentSecretIdx uint64
	PerCommitmentSecret    string
	NodeId                 string
}

A informational request that reveals counterparty per-commitment secret.

func ParseReleaseCounterpartyPerCommitmentSecretRequest(webhook webhooks.WebhookEvent) (*ReleaseCounterpartyPerCommitmentSecretRequest, error)

func (r *ReleaseCounterpartyPerCommitmentSecretRequest) Type() objects.RemoteSigningSubEventType

type ReleasePaymentPreimageRequest ¶ added in v0.5.0

type ReleasePaymentPreimageRequest struct {
	InvoiceId      string
	Nonce          *string
	BitcoinNetwork objects.BitcoinNetwork
	IsUma          bool
	IsLnurl        bool
}

A signing request asking for a payment preimage to be released.

func ParseReleasePaymentPreimageRequest(webhook webhooks.WebhookEvent) (*ReleasePaymentPreimageRequest, error)

func (r *ReleasePaymentPreimageRequest) Type() objects.RemoteSigningSubEventType

type ReleasePaymentPreimageResponse ¶ added in v0.5.0

type ReleasePaymentPreimageResponse struct {
	InvoiceId       string
	PaymentPreimage string
}

func HandleReleaseInvoicePreimageRequest(request *ReleasePaymentPreimageRequest, seedBytes []byte) (*ReleasePaymentPreimageResponse, error)

func (r ReleasePaymentPreimageResponse) GraphqlResponse() *GraphQLResponse

type ReleasePerCommitmentSecretRequest ¶ added in v0.5.0

type ReleasePerCommitmentSecretRequest struct {
	ChannelId             string
	DerivationPath        string
	PerCommitmentPointIdx uint64
	NodeId                string
	BitcoinNetwork        objects.BitcoinNetwork
}

A signing request asking for a per-commitment secret to be released for a particular channel. The per-commitment secret is the secret described in bolt 3.

func ParseReleasePerCommitmentSecretRequest(webhook webhooks.WebhookEvent) (*ReleasePerCommitmentSecretRequest, error)

func (r *ReleasePerCommitmentSecretRequest) Type() objects.RemoteSigningSubEventType

type ReleasePerCommitmentSecretResponse ¶ added in v0.5.0

type ReleasePerCommitmentSecretResponse struct {
	ChannelId             string
	PerCommitmentPointIdx uint64
	PerCommitmentSecret   string
}

func HandleReleasePerCommitmentSecretRequest(request *ReleasePerCommitmentSecretRequest, seedBytes []byte) (*ReleasePerCommitmentSecretResponse, error)

func (r ReleasePerCommitmentSecretResponse) GraphqlResponse() *GraphQLResponse

type SignInvoiceRequest ¶ added in v0.5.0

type SignInvoiceRequest struct {
	InvoiceId          string
	PaymentRequestHash string
	BitcoinNetwork     objects.BitcoinNetwork
}

A signing request asking for an invoice to be signed. The invoice is signed using the node's identity private key. This request is only for nodes created before 10/06/2023.

func ParseSignInvoiceRequest(webhook webhooks.WebhookEvent) (*SignInvoiceRequest, error)

func (r *SignInvoiceRequest) Type() objects.RemoteSigningSubEventType

type SignInvoiceResponse ¶ added in v0.5.0

type SignInvoiceResponse struct {
	InvoiceId  string
	Signature  string
	RecoveryId int32
}

func HandleSignInvoiceRequest(request *SignInvoiceRequest, seedBytes []byte) (*SignInvoiceResponse, error)

func (r SignInvoiceResponse) GraphqlResponse() *GraphQLResponse

type SignatureResponse ¶ added in v0.5.0

type SignatureResponse struct {
	Id        string `json:"id"`
	Signature string `json:"signature"`
}

SignatureResponse A separate type is required for the response because the json field names are different from objects.Signature.

type SigningJob ¶

type SigningJob struct {
	Id                        string  `json:"id"`
	DerivationPath            string  `json:"derivation_path"`
	Message                   string  `json:"message"`
	AddTweak                  *string `json:"add_tweak"`
	MulTweak                  *string `json:"mul_tweak"`
	Script                    *string `json:"script"`
	Transaction               *string `json:"transaction"`
	Amount                    *int64  `json:"amount"`
	DestinationDerivationPath string  `json:"destination_derivation_path"`
}

A signing job is a request to sign a message with a particular key. The signig key is computed using the node's master key and the parameter. DerivationPath is the bip32 derivation path to get the key from the master key `k`. Then apply MulTweak * k + AddTweak to get the final signing key.

func (j *SigningJob) AddTweakBytes() ([]byte, error)

func (j *SigningJob) BitcoinTx() (wire.MsgTx, error)

func (j *SigningJob) MessageBytes() ([]byte, error)

func (j *SigningJob) MulTweakBytes() ([]byte, error)

type SigningRequest ¶ added in v0.5.0

type SigningRequest interface {
	Type() objects.RemoteSigningSubEventType
}

func ParseRemoteSigningRequest(webhook webhooks.WebhookEvent) (SigningRequest, error)

type SigningResponse ¶ added in v0.5.0

type SigningResponse interface {
	GraphqlResponse() *GraphQLResponse
}

func GraphQLResponseForRemoteSigningWebhook(
	validator Validator,
	webhook webhooks.WebhookEvent,
	seedBytes []byte,
) (SigningResponse, error)

func HandleSigningRequest(request SigningRequest, seedBytes []byte) (SigningResponse, error)

type Validator ¶

type Validator interface {
	ShouldSign(webhook webhooks.WebhookEvent) bool
}

Validator an interface which decides whether to sign or reject a remote signing webhook event.