Skip to content

📝 [client] Document parameters of NewLedgerChannelProposal #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ggwpez merged 1 commit into from
Apr 12, 2021
Merged

📝 [client] Document parameters of NewLedgerChannelProposal #43

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion client/proposalmsgs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,12 @@ func (LedgerChannelProposal) Matches(acc ChannelProposalAccept) bool {
}

// NewLedgerChannelProposal creates a ledger channel proposal and applies the
// supplied options. For more information, see ProposalOpts.
// supplied options.
// challengeDuration is the on-chain challenge duration in seconds.
// participant is our wallet address.
// initBals are the initial balances.
// peers are the wire addresses of the channel participants.
// For more information, see ProposalOpts.
func NewLedgerChannelProposal(
challengeDuration uint64,
participant wallet.Address,
Expand Down