Skip to content
This repository has been archived by the owner on Oct 7, 2019. It is now read-only.

The name 'fulfillment' is ambiguous #18

Open
michielbdejong opened this issue Nov 15, 2017 · 1 comment
Open

The name 'fulfillment' is ambiguous #18

michielbdejong opened this issue Nov 15, 2017 · 1 comment

Comments

@michielbdejong
Copy link
Contributor

In #17, a fulfillment packet was introduced, which can be used as a standard representation of the arbitrary transport-layer or application-layer data, that may be passed back from the receiver, along the payment path, to the sender.

However, in other contexts, the term 'fulfillment' is already used to refer to the preimage which unlocks the hashlock of a conditional transfer.

@justmoon Wouldn't 'serializeIlpFulfillmentData' be a better name than 'serializeIlpFulfillment'?

@justmoon
Copy link
Contributor

I would be down with:

  • serializeIlpPayment => serializeIlpPaymentData
  • serializeIlpError => serializeIlpRejectionData
  • serializeIlpFulfillment => serializeIlpFulfillmentData

... to keep it consistent. (Read as: IlpPaymentData travels with a payment, IlpFulfillmentData travels with a fulfillment and IlpRejectionData travels with a rejection.)

We'd keep the old method names around for backwards compatibility, of course, but perhaps mark with util.deprecate. And I'd make a PR for the spec to use the same new terminology.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants