Skip to content

Commit 9865f1e

Browse files
committed
Link to sale interface code
1 parent 8a2f2fc commit 9865f1e

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

packages/apps/docs/src/pages/marmalade/architecture/sale-contracts.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ The function `enforce-quote-update` is called in from the `buy` step in the ledg
3131
- price (type: decimal): This parameter represents the finale price associated with the sale.
3232

3333
## Available Sale Contracts
34+
The available sale contracts are listed below. More sale contracts will follow but in the meantime, you can also create your own sale contract. The sale contracts can be found in the [Marmalade Github repository](https://github.com/kadena-io/marmalade/tree/v2/pact/sale-contracts) under `pact/sale-contracts`. Just create a pull request and we will review your sale contract and take care of deployment and whitelisting it in the Policy Manager.
3435

35-
**Conventional Auction**
36+
**Conventional Auction** (Mainnet deployment pending)
3637

3738
A conventional auction is a sale contract that allows for the sale of a token through a conventional auction. The seller can set a reserve price which will ensure that the token is not sold below a certain price. The auction will run for a set amount of time and the highest bidder will win the auction. If the reserve price is not met, the seller can choose to cancel the auction and the token will be returned to the seller.
3839
The contract is deployed at `marmalade-sale.conventional-auction`.
3940

40-
More sale contracts will follow but in the meantime, you can also create your own sale contract. The sale contracts can be found in the [Marmalade Github repository](https://github.com/kadena-io/marmalade) under `pact/sale-contracts`. Just create a pull request and we will review your sale contract and take care of deployment and whitelisting it in the Policy Manager.
4141

4242
## Using a Sale Contract
4343
The sale contract can be used by providing the sale contract's module name as part of the quote specification when calling the `offer` function in the ledger. Here's an example of the quote specification with the sale contract's module name mentioned under the key `sale-type`.
@@ -54,4 +54,6 @@ The sale contract can be used by providing the sale contract's module name as pa
5454
}
5555
```
5656

57-
**_Note:_** When using a sale contract the `sale-price` during `offer` must always be `0.0`, since the sale contract will be responsible for updating the price during the `buy` step.
57+
**_Note:_** When using a sale contract the `sale-price` during `offer` must always be `0.0`, since the sale contract will be responsible for updating the price during the `buy` step.
58+
59+
[Sale Interface Code](https://github.com/kadena-io/marmalade/blob/v2/pact/policy-manager/sale.interface.pact)

0 commit comments

Comments
 (0)