payment

Documentation

Index

• type Cheque
  • func NewCheque(senderAddr, receiverAddr, uuid, amount string, feeRate uint64, ...) (*Cheque, error)
  • func (c *Cheque) GenerateIssuingChequeUnsignedTx(client rpc.Client) (*types.Transaction, error)
  • func (c *Cheque) Send(client rpc.Client) (*types.Hash, error)
  • func (c *Cheque) SignTx(key crypto.Key) (*types.Transaction, error)
• type ClaimCheque
  • func NewClaimCheque(receiverAddr, uuid string, feeRate uint64, systemScripts *utils.SystemScripts) (*ClaimCheque, error)
  • func (c *ClaimCheque) GenerateClaimChequeUnsignedTx(client rpc.Client) (*types.Transaction, error)
  • func (c *ClaimCheque) Send(client rpc.Client) (*types.Hash, error)
  • func (c *ClaimCheque) SignTx(key crypto.Key) (*types.Transaction, error)
• type Payment
  • func NewPayment(from, to string, amount, feeRate uint64) (*Payment, error)
  • func (p *Payment) GenerateTx(client rpc.Client, systemScripts *utils.SystemScripts) (*types.Transaction, error)
  • func (p *Payment) Send(client rpc.Client) (*types.Hash, error)
  • func (p *Payment) Sign(key crypto.Key) (*types.Transaction, error)
• type Sudt
  • func NewSudt(senderAddresses []string, receiverInfo map[string]string, ...) (*Sudt, error)
  • func (s *Sudt) GenerateTransferSudtUnsignedTx(client rpc.Client) (*types.Transaction, error)
  • func (s *Sudt) Send(client rpc.Client) (*types.Hash, error)
  • func (s *Sudt) SignTx(keys map[string]crypto.Key) (*types.Transaction, error)
• type WithdrawCheque
  • func NewWithdrawCheque(senderAddr, receiverAddr, uuid, amount string, feeRate uint64, ...) (*WithdrawCheque, error)
  • func (c *WithdrawCheque) GenerateWithdrawChequeUnsignedTx(client rpc.Client) (*types.Transaction, error)
  • func (c *WithdrawCheque) Send(client rpc.Client) (*types.Hash, error)
  • func (c *WithdrawCheque) SignTx(key crypto.Key) (*types.Transaction, error)

Types

type Cheque

type Cheque struct {
	Sender   *types.Script
	Receiver *types.Script
	UUID     string
	Amount   *big.Int
	FeeRate  uint64
	// contains filtered or unexported fields
}

Cheque object

func NewCheque

func NewCheque(senderAddr, receiverAddr, uuid, amount string, feeRate uint64, systemScripts *utils.SystemScripts) (*Cheque, error)

NewCheque returns a new Cheque object

func (*Cheque) GenerateIssuingChequeUnsignedTx

func (c *Cheque) GenerateIssuingChequeUnsignedTx(client rpc.Client) (*types.Transaction, error)

GenerateIssuingChequeUnsignedTx generate an unsigned transaction for issuing a cheque cell

func (*Cheque) Send

func (c *Cheque) Send(client rpc.Client) (*types.Hash, error)

Send can send a tx to tx pool

func (*Cheque) SignTx

func (c *Cheque) SignTx(key crypto.Key) (*types.Transaction, error)

SignTx sign an unsigned issuing cheque transaction and return an signed transaction

type ClaimCheque

type ClaimCheque struct {
	Receiver *types.Script
	UUID     string
	FeeRate  uint64
	// contains filtered or unexported fields
}

ClaimCheque object

func NewClaimCheque

func NewClaimCheque(receiverAddr, uuid string, feeRate uint64, systemScripts *utils.SystemScripts) (*ClaimCheque, error)

NewClaimCheque returns a new ClaimCheque object

func (*ClaimCheque) GenerateClaimChequeUnsignedTx

func (c *ClaimCheque) GenerateClaimChequeUnsignedTx(client rpc.Client) (*types.Transaction, error)

GenerateClaimChequeUnsignedTx generate an unsigned transaction for claim cheque cells

func (*ClaimCheque) Send

func (c *ClaimCheque) Send(client rpc.Client) (*types.Hash, error)

Send can send a tx to tx pool

func (*ClaimCheque) SignTx

func (c *ClaimCheque) SignTx(key crypto.Key) (*types.Transaction, error)

SignTx sign an unsigned claim cheque transaction and return an signed transaction

type Payment

type Payment struct {
	From    *types.Script
	To      *types.Script
	Amount  uint64
	FeeRate uint64
	// contains filtered or unexported fields
}

func NewPayment

func NewPayment(from, to string, amount, feeRate uint64) (*Payment, error)

NewPayment returns a Payment object, amount's unit is shannon

func (*Payment) GenerateTx

func (p *Payment) GenerateTx(client rpc.Client, systemScripts *utils.SystemScripts) (*types.Transaction, error)

func (*Payment) Send

func (p *Payment) Send(client rpc.Client) (*types.Hash, error)

func (*Payment) Sign

func (p *Payment) Sign(key crypto.Key) (*types.Transaction, error)

type Sudt

type Sudt struct {
	Senders        []*types.Script
	ReceiverInfo   []types.ReceiverInfo
	CkbPayer       *types.Script
	CkbChanger     *types.Script
	SudtChanger    *types.Script
	UUID           string
	TransferAmount *big.Int
	FeeRate        uint64
	// contains filtered or unexported fields
}

func NewSudt

func NewSudt(senderAddresses []string, receiverInfo map[string]string, ckbPayerAddress, ckbChangeAddress, sudtChangeAddress, uuid string, feeRate uint64, systemScripts *utils.SystemScripts) (*Sudt, error)

NewSudt returns a new NewSudt object receiverInfo's key is an address and its value is a sudt amount

func (*Sudt) GenerateTransferSudtUnsignedTx

func (s *Sudt) GenerateTransferSudtUnsignedTx(client rpc.Client) (*types.Transaction, error)

GenerateTransferSudtUnsignedTx generate an unsigned transaction for transfer sudt

func (*Sudt) Send

func (s *Sudt) Send(client rpc.Client) (*types.Hash, error)

Send can send a tx to tx pool

func (*Sudt) SignTx

func (s *Sudt) SignTx(keys map[string]crypto.Key) (*types.Transaction, error)

SignTx sign an unsigned sudt transfer transaction and return an signed transaction The order of keys must be consistent with the order of locks in senders

type WithdrawCheque

type WithdrawCheque struct {
	Sender   *types.Script
	Receiver *types.Script
	UUID     string
	FeeRate  uint64
	Amount   *big.Int
	// contains filtered or unexported fields
}

WithdrawCheque object

func NewWithdrawCheque

func NewWithdrawCheque(senderAddr, receiverAddr, uuid, amount string, feeRate uint64, systemScripts *utils.SystemScripts) (*WithdrawCheque, error)

NewWithdrawCheque returns a new WithdrawCheque object

func (*WithdrawCheque) GenerateWithdrawChequeUnsignedTx

func (c *WithdrawCheque) GenerateWithdrawChequeUnsignedTx(client rpc.Client) (*types.Transaction, error)

GenerateWithdrawChequeUnsignedTx generate an unsigned transaction for withdraw the cheque cell

func (*WithdrawCheque) Send

func (c *WithdrawCheque) Send(client rpc.Client) (*types.Hash, error)

Send can send a tx to tx pool

func (*WithdrawCheque) SignTx

func (c *WithdrawCheque) SignTx(key crypto.Key) (*types.Transaction, error)

SignTx sign an unsigned withdraw cheque transaction and return an signed transaction