Skip to content
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.

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

initial draft of ledger API #90

Closed
wants to merge 6 commits into from

Conversation

diminator
Copy link

I started and initial draft for guidelineing the API as discussed in last call.

@adrianhopebailie: Is this the kind of format you were looking for?

cc @justmoon @emschwartz


##### Request
```http
GET /transfers/<ID> HTTP/1.1
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The format for <ID> should be specified. Recommend a lowercase UUID.

@justmoon
Copy link
Member

@emschwartz @adrianhopebailie

Each RFC number should be only one document, and we should never redefine/reassign. (Better to have a hole/deprecated RFC than a number that meant different things at different times.)

IL-RFC 0004 is the JavaScript ledger plugin interface. So we should assign a new RFC number for this imo.

remove connectors endpoint
ID types
authorization placeholder
added image
quotes
## Requirements

In order for ledgers to connect seamlessly with any of the ILP plugins `ilp-plugin-<ledgerID>`, the ledger needs to provide:
- a RESTful HTTP API with endpoints to `transfer` (or `transaction`, `asset`) objects
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a RESTful HTTP API with endpoints to initiate transfers and submit fulfillments.

@diminator
Copy link
Author

IL-RFC 0004 is the JavaScript ledger plugin interface. So we should assign a new RFC number for this imo.

assigned it to RFC-0012

ilpFulfillment
```

## PUSH notifications (websockets)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We will need to define what these messages would look like? Just JSON objects?

@emschwartz
Copy link
Member

Shall we close this in favor of #125?

@diminator diminator closed this Jan 2, 2017
@mDuo13 mDuo13 mentioned this pull request Jul 10, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants