Skip to content

Commit

Permalink
docs(SPV-1341): fix documentation of delete paymail
Browse files Browse the repository at this point in the history
  • Loading branch information
dzolt-4chain committed Jan 21, 2025
1 parent 98f27a1 commit eba541c
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 2 additions & 0 deletions admin_api.go
Original file line number Diff line number Diff line change
Expand Up @@ -330,6 +330,8 @@ func (a *AdminAPI) CreatePaymail(ctx context.Context, cmd *commands.CreatePaymai
}

// DeletePaymail deletes a paymail address with via the Admin Paymails API.
// This function accepts an id, which corresponds to the database record id of the paymail to be deleted.
//
// It returns an error if the API request fails. A nil error indicates that the paymail
// was successfully deleted.
func (a *AdminAPI) DeletePaymail(ctx context.Context, id string) error {
Expand Down
2 changes: 1 addition & 1 deletion regression_tests/spv_wallet_user.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ type user struct {
xPriv string // The extended private key for the user.
xPub string // The extended public key for the user.
paymail string // The paymail address associated with the user.
paymailID string //The paymail id associated with the users paymail.
paymailID string // The paymail id associated with the users paymail.
client *wallet.UserAPI // The API client for interacting with the SPV Wallet.
}

Expand Down

0 comments on commit eba541c

Please sign in to comment.