signtransaction

Documentation

Index

• type ForbiddenResponse
• type InvoiceError
• type Reason
• type RequestBody
  • func CreateSolanaRequest(txn solana.Transaction, invoiceList *commonpb.InvoiceList) (*RequestBody, error)
  • func CreateStellarRequest(v version.KinVersion, req *transactionpb.SubmitTransactionRequest) (*RequestBody, error)
• type SuccessResponse
  • func (r *SuccessResponse) GetEnvelopeXDR() (*xdr.TransactionEnvelope, error)

Types

type ForbiddenResponse

type ForbiddenResponse struct {
	Message       string         `json:"message"`
	InvoiceErrors []InvoiceError `json:"invoice_errors"`
}

ForbiddenResponse represents a 403 Forbidden response to a sign transaction request.

type InvoiceError

type InvoiceError struct {
	OperationIndex uint32 `json:"operation_index"`
	Reason         Reason `json:"reason"`
}

InvoiceError is an error specific to an operation (or its corresponding invoice) in the transaction

type Reason

type Reason string

Reason indicates why a transaction operation was rejected

const (
	AlreadyPaid      Reason = "already_paid"
	WrongDestination Reason = "wrong_destination"
	SKUNotFound      Reason = "sku_not_found"
)

type RequestBody

type RequestBody struct {
	KinVersion int `json:"kin_version"`
	// EnvelopeXDR is a base64-encoded transaction envelope XDR
	EnvelopeXDR []byte `json:"envelope_xdr"`
	// SolanaTransaction is a base64-encoded Solana transaction
	SolanaTransaction []byte `json:"solana_transaction"`
	// InvoiceList is a base64-encoded protobuf InvoiceList
	InvoiceList []byte `json:"invoice_list,omitempty"`
}

RequestBody contains the body of a sign transaction request.

func CreateSolanaRequest

func CreateSolanaRequest(txn solana.Transaction, invoiceList *commonpb.InvoiceList) (*RequestBody, error)

func CreateStellarRequest

func CreateStellarRequest(v version.KinVersion, req *transactionpb.SubmitTransactionRequest) (*RequestBody, error)

type SuccessResponse

type SuccessResponse struct {
	// EnvelopeXDR is a base64-encoded transaction envelope XDR
	EnvelopeXDR []byte `json:"envelope_xdr"`
}

SuccessResponse represents a 200 OK response to a sign transaction request.

func (*SuccessResponse) GetEnvelopeXDR

func (r *SuccessResponse) GetEnvelopeXDR() (*xdr.TransactionEnvelope, error)