Skip to content

Commit 43e30a5

Browse files
authored
docs: remove the draft suffix in the specification (#136)
1 parent 9424dc0 commit 43e30a5

10 files changed

+17
-17
lines changed

packages/advanced-logic/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ npm install @requestnetwork/advanced-logic
1111

1212
## Specifications
1313

14-
Specifications of Advanced Logic can be found [here](/packages/advanced-logic/specs/advanced-logic-specs-0.1.0-DRAFT.md)
14+
Specifications of Advanced Logic can be found [here](/packages/advanced-logic/specs/advanced-logic-specs-0.1.0.md)
1515

1616
## Implemented Extensions
1717

1818
### Content Data
1919

2020
This extension allows linking content data to the request. The content data can be used to give extra information about the request. You can find examples of content data format [here](/packages/data-format).
2121

22-
Specifications of Content Data can be found [here](/packages/advanced-logic/specs/content-data-0.1.0-DRAFT.md)
22+
Specifications of Content Data can be found [here](/packages/advanced-logic/specs/content-data-0.1.0.md)
2323

2424
### Declarative payments
2525

@@ -28,15 +28,15 @@ The payments and refunds are documented by the payer and the payee of the reques
2828

2929
This extension do not ensure payment detection, only a consensus is made between the payer and the payee.
3030

31-
Specifications of Declarative payments can be found [here](/packages/advanced-logic/specs/payment-network-any-declarative-0.1.0-DRAFT.md)
31+
Specifications of Declarative payments can be found [here](/packages/advanced-logic/specs/payment-network-any-declarative-0.1.0.md)
3232

3333
### Address based bitcoin payments
3434

3535
This extension allows the payments and the refunds to be made on the Bitcoin blockchain.
3636

3737
Note: this extension can be used with the bitcoin mainnet and testnet.
3838

39-
Specifications of Address based bitcoin payments can be found [here](/packages/advanced-logic/specs/payment-network-btc-address-based-0.1.0-DRAFT.md)
39+
Specifications of Address based bitcoin payments can be found [here](/packages/advanced-logic/specs/payment-network-btc-address-based-0.1.0.md)
4040

4141
## Contributing
4242

packages/advanced-logic/specs/content-data-0.1.0-DRAFT.md renamed to packages/advanced-logic/specs/content-data-0.1.0.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ You can be interested in this document if:
55
- you want to create your own implementation of the Request protocol
66
- you are curious enough to dive and see what is under the hood of the Request protocol
77

8-
Prerequisite: Having read the advanced logic specification (see [here](./advanced-logic-specs-0.1.0-DRAFT.md))
8+
Prerequisite: Having read the advanced logic specification (see [here](./advanced-logic-specs-0.1.0.md))
99

1010
## Description
1111

packages/advanced-logic/specs/payment-network-btc-address-based-0.1.0-DRAFT.md renamed to packages/advanced-logic/specs/payment-network-btc-address-based-0.1.0.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ You can be interested in this document if:
55
- you want to create your own implementation of the Request protocol
66
- you are curious enough to dive and see what is under the hood of the Request protocol
77

8-
Prerequisite: Having read the advanced logic specification (see [here](./advanced-logic-specs-0.1.0-DRAFT.md)).
8+
Prerequisite: Having read the advanced logic specification (see [here](./advanced-logic-specs-0.1.0.md)).
99

1010
## Description
1111

packages/advanced-logic/specs/payment-network-erc20-address-based-0.1.0-DRAFT.md renamed to packages/advanced-logic/specs/payment-network-erc20-address-based-0.1.0.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ You may be interested in this document if:
55
- you want to create your own implementation of the Request protocol
66
- you are curious enough to dive and see what is under the hood of the Request protocol
77

8-
Prerequisite: Having read the advanced logic specification (see [here](./advanced-logic-specs-0.1.0-DRAFT.md)).
8+
Prerequisite: Having read the advanced logic specification (see [here](./advanced-logic-specs-0.1.0.md)).
99

1010
## Description
1111

packages/advanced-logic/specs/payment-network-erc20-proxy-contract-0.1.0-DRAFT.md renamed to packages/advanced-logic/specs/payment-network-erc20-proxy-contract-0.1.0.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ You may be interested in this document if:
55
- you want to create your own implementation of the Request protocol
66
- you are curious enough to dive and see what is under the hood of the Request protocol
77

8-
Prerequisite: Having read the advanced logic specification (see [here](./advanced-logic-specs-0.1.0-DRAFT.md)).
8+
Prerequisite: Having read the advanced logic specification (see [here](./advanced-logic-specs-0.1.0.md)).
99

1010
## Description
1111

packages/advanced-logic/specs/payment-network-eth-input-data-0.1.0-DRAFT.md renamed to packages/advanced-logic/specs/payment-network-eth-input-data-0.1.0.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ You may be interested in this document if:
55
- you want to create your own implementation of the Request protocol
66
- you are curious enough to dive and see what is under the hood of the Request protocol
77

8-
Prerequisite: Having read the advanced logic specification (see [here](./advanced-logic-specs-0.1.0-DRAFT.md)).
8+
Prerequisite: Having read the advanced logic specification (see [here](./advanced-logic-specs-0.1.0.md)).
99

1010
## Description
1111

packages/payment-detection/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ From the information provided in payment network, the library will feed the prop
1414

1515
The payment networks available are:
1616

17-
- `Types.Payment.PAYMENT_NETWORK_ID.BITCOIN_ADDRESS_BASED` ('pn-bitcoin-address-based'): handle Bitcoin payments associated to a BTC address to the request, every transaction hitting this address will be consider as a payment. Optionally, the payer can provide a BTC address for the refunds. Note that **the addresses must be used only for one and only one request** otherwise one transaction will be considered as a payment for more than one request. (see [the specification](https://github.com/RequestNetwork/requestNetwork/blob/master/packages/advanced-logic/specs/payment-network-btc-address-based-0.1.0-DRAFT.md))
17+
- `Types.Payment.PAYMENT_NETWORK_ID.BITCOIN_ADDRESS_BASED` ('pn-bitcoin-address-based'): handle Bitcoin payments associated to a BTC address to the request, every transaction hitting this address will be consider as a payment. Optionally, the payer can provide a BTC address for the refunds. Note that **the addresses must be used only for one and only one request** otherwise one transaction will be considered as a payment for more than one request. (see [the specification](https://github.com/RequestNetwork/requestNetwork/blob/master/packages/advanced-logic/specs/payment-network-btc-address-based-0.1.0.md))
1818
- `Types.Payment.PAYMENT_NETWORK_ID.TESTNET_BITCOIN_ADDRESS_BASED` ('pn-testnet-bitcoin-address-based'): Same as previous but for the bitcoin testnet (for test purpose)
1919
- `Types.Payment.PAYMENT_NETWORK_ID.ERC20_ADDRESS_BASED`('pn-erc20-address-based'): Same as `BITCOIN_ADDRESS_BASED`, for ERC20 payments.
20-
- `Types.Payment.PAYMENT_NETWORK_ID.ERC20_PROXY_CONTRACT`('pn-erc20-proxy-contract'): uses an intermediary contract to document which request is being paid, through the `PaymentReference`. (see [the specification](https://github.com/RequestNetwork/requestNetwork/blob/master/packages/advanced-logic/specs/payment-network-erc20-address-based-0.1.0-DRAFT.md))
21-
- `Types.Payment.PAYMENT_NETWORK_ID.ETH_INPUT_DATA`('pn-eth-input-data'): uses the transaction input data to pass the `PaymentReference`. (see [the specification](https://github.com/RequestNetwork/requestNetwork/blob/master/packages/advanced-logic/specs/payment-network-eth-input-data-0.1.0-DRAFT.md))
22-
- `Types.Payment.PAYMENT_NETWORK_ID.DECLARATIVE`('pn-any-declarative'): a manual alternative, where payer can declare a payment sent, and payee can declare it received, working for any currency. (see [the specification](https://github.com/RequestNetwork/requestNetwork/blob/master/packages/advanced-logic/specs/payment-network-any-declarative-0.1.0-DRAFT.md))
20+
- `Types.Payment.PAYMENT_NETWORK_ID.ERC20_PROXY_CONTRACT`('pn-erc20-proxy-contract'): uses an intermediary contract to document which request is being paid, through the `PaymentReference`. (see [the specification](https://github.com/RequestNetwork/requestNetwork/blob/master/packages/advanced-logic/specs/payment-network-erc20-address-based-0.1.0.md))
21+
- `Types.Payment.PAYMENT_NETWORK_ID.ETH_INPUT_DATA`('pn-eth-input-data'): uses the transaction input data to pass the `PaymentReference`. (see [the specification](https://github.com/RequestNetwork/requestNetwork/blob/master/packages/advanced-logic/specs/payment-network-eth-input-data-0.1.0.md))
22+
- `Types.Payment.PAYMENT_NETWORK_ID.DECLARATIVE`('pn-any-declarative'): a manual alternative, where payer can declare a payment sent, and payee can declare it received, working for any currency. (see [the specification](https://github.com/RequestNetwork/requestNetwork/blob/master/packages/advanced-logic/specs/payment-network-any-declarative-0.1.0.md))

packages/request-client.js/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -411,12 +411,12 @@ From the information provided in payment network, the library will feed the prop
411411

412412
The payment networks available are:
413413

414-
- `Types.Payment.PAYMENT_NETWORK_ID.BITCOIN_ADDRESS_BASED` ('pn-bitcoin-address-based'): handle Bitcoin payments associated to a BTC address to the request, every transaction hitting this address will be consider as a payment. Optionally, the payer can provide a BTC address for the refunds. Note that **the addresses must be used only for one and only one request** otherwise one transaction will be considered as a payment for more than one request. (see [the specification](https://github.com/RequestNetwork/requestNetwork/blob/master/packages/advanced-logic/specs/payment-network-btc-address-based-0.1.0-DRAFT.md))
414+
- `Types.Payment.PAYMENT_NETWORK_ID.BITCOIN_ADDRESS_BASED` ('pn-bitcoin-address-based'): handle Bitcoin payments associated to a BTC address to the request, every transaction hitting this address will be consider as a payment. Optionally, the payer can provide a BTC address for the refunds. Note that **the addresses must be used only for one and only one request** otherwise one transaction will be considered as a payment for more than one request. (see [the specification](https://github.com/RequestNetwork/requestNetwork/blob/master/packages/advanced-logic/specs/payment-network-btc-address-based-0.1.0.md))
415415
- `Types.Payment.PAYMENT_NETWORK_ID.TESTNET_BITCOIN_ADDRESS_BASED` ('pn-testnet-bitcoin-address-based'): Same as previous but for the bitcoin testnet (for test purpose)
416416
- `Types.Payment.PAYMENT_NETWORK_ID.ERC20_ADDRESS_BASED`('pn-erc20-address-based'): Same as `BITCOIN_ADDRESS_BASED`, for ERC20 payments.
417-
- `Types.Payment.PAYMENT_NETWORK_ID.ERC20_PROXY_CONTRACT`('pn-erc20-proxy-contract'): uses an intermediary contract to document which request is being paid, through the `PaymentReference`. (see [the specification](https://github.com/RequestNetwork/requestNetwork/blob/master/packages/advanced-logic/specs/payment-network-erc20-address-based-0.1.0-DRAFT.md))
418-
- `Types.Payment.PAYMENT_NETWORK_ID.ETH_INPUT_DATA`('pn-eth-input-data'): uses the transaction input data to pass the `PaymentReference`. (see [the specification](https://github.com/RequestNetwork/requestNetwork/blob/master/packages/advanced-logic/specs/payment-network-eth-input-data-0.1.0-DRAFT.md))
419-
- `Types.Payment.PAYMENT_NETWORK_ID.DECLARATIVE`('pn-any-declarative'): a manual alternative, where payer can declare a payment sent, and payee can declare it received, working for any currency. (see [the specification](https://github.com/RequestNetwork/requestNetwork/blob/master/packages/advanced-logic/specs/payment-network-any-declarative-0.1.0-DRAFT.md))
417+
- `Types.Payment.PAYMENT_NETWORK_ID.ERC20_PROXY_CONTRACT`('pn-erc20-proxy-contract'): uses an intermediary contract to document which request is being paid, through the `PaymentReference`. (see [the specification](https://github.com/RequestNetwork/requestNetwork/blob/master/packages/advanced-logic/specs/payment-network-erc20-address-based-0.1.0.md))
418+
- `Types.Payment.PAYMENT_NETWORK_ID.ETH_INPUT_DATA`('pn-eth-input-data'): uses the transaction input data to pass the `PaymentReference`. (see [the specification](https://github.com/RequestNetwork/requestNetwork/blob/master/packages/advanced-logic/specs/payment-network-eth-input-data-0.1.0.md))
419+
- `Types.Payment.PAYMENT_NETWORK_ID.DECLARATIVE`('pn-any-declarative'): a manual alternative, where payer can declare a payment sent, and payee can declare it received, working for any currency. (see [the specification](https://github.com/RequestNetwork/requestNetwork/blob/master/packages/advanced-logic/specs/payment-network-any-declarative-0.1.0.md))
420420

421421
## Contributing
422422

0 commit comments

Comments
 (0)