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.

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

Docs : Add Deprecation Notes #596

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Docs : Add Deprecation Notes #596

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
30 changes: 29 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,42 @@ The process for submitting an RFC is documented in the [RFC Process](CONTRIBUTIN

For the main reference implementation of the ILP stack, see [Interledger.js](https://github.com/interledgerjs).

## Deprecation Notice

**Warning: This feature is deprecated and will be removed in future versions.**

Please avoid using this feature in new projects. Instead, consider using the recommended alternative:

- 0002-crypto-conditions
- 0003-interledger-protocol
- 0004-ledger-plugin-interface
- 0005-optimistic-transport-protocol
- 0006-universal-transport-protocol
- 0007-atomic-transport-protocol
- 0008-interledger-quoting-protocol
- 0008-interledger-quoting-protocol
- 0010-connector-to-connector-protocol
- 0011-interledger-payment-request
- 0012-five-bells-ledger-api
- 0014-paid-http-apis
- 0016-pre-shared-key
- 0017-ledger-requirements
- 0020-explain-like-im-five
- 0021-plugin-rpc-api
- 0024-ledger-plugin-interface-2
- 0025-pre-shared-key-2
- 0028-web-monetization
- 0036-spsp-pull-payments
- 0037-spsp-invoices

## ASN.1 and OER

A number of the protocols define data structures in ASN.1 notation. The collection of definitions is in [asn1](./asn1).

Changes to these files are automatically checked and compiled during CI using online ASN.1 tools from OSS Nokalva. If you need ASN.1 tools for any work you're doing on Interledger please contact them for assistance.

[![OSS Nokalva](https://raw.githubusercontent.com/interledger/rfcs/master/assets/osslogo.png)](http://asn1-playground.oss.com/)

You can also check your ASN.1 definitions online using OSS Nokalva's ASN.1 Playground available at http://asn1.io/

The default encoding rules for Interledger protocols are the Canonical Octet Encoding Rules as described in [Notes on OER encoding](./0030-notes-on-oer-encoding/0030-notes-on-oer-encoding.md).
Expand Down