From 9865f1e9bd9e908e08381e348728ac4587fb22b5 Mon Sep 17 00:00:00 2001 From: jermaine150 Date: Wed, 25 Oct 2023 15:34:59 +0200 Subject: [PATCH 1/2] Link to sale interface code --- .../src/pages/marmalade/architecture/sale-contracts.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/packages/apps/docs/src/pages/marmalade/architecture/sale-contracts.md b/packages/apps/docs/src/pages/marmalade/architecture/sale-contracts.md index f2a41119bb..03fe4617e2 100644 --- a/packages/apps/docs/src/pages/marmalade/architecture/sale-contracts.md +++ b/packages/apps/docs/src/pages/marmalade/architecture/sale-contracts.md @@ -31,13 +31,13 @@ The function `enforce-quote-update` is called in from the `buy` step in the ledg - price (type: decimal): This parameter represents the finale price associated with the sale. ## Available Sale Contracts +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. -**Conventional Auction** +**Conventional Auction** (Mainnet deployment pending) 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. The contract is deployed at `marmalade-sale.conventional-auction`. -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. ## Using a Sale Contract 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 } ``` -**_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. \ No newline at end of file +**_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. + +[Sale Interface Code](https://github.com/kadena-io/marmalade/blob/v2/pact/policy-manager/sale.interface.pact) \ No newline at end of file From e7ce856ff81b6c0409a539e202653d54ca8ed34f Mon Sep 17 00:00:00 2001 From: jermaine150 Date: Wed, 25 Oct 2023 15:42:10 +0200 Subject: [PATCH 2/2] Fixed broken link --- packages/apps/docs/src/pages/marmalade/index.tsx | 3 --- 1 file changed, 3 deletions(-) diff --git a/packages/apps/docs/src/pages/marmalade/index.tsx b/packages/apps/docs/src/pages/marmalade/index.tsx index 244d674ef7..9e094e7f2e 100644 --- a/packages/apps/docs/src/pages/marmalade/index.tsx +++ b/packages/apps/docs/src/pages/marmalade/index.tsx @@ -84,9 +84,6 @@ const Home: FC = ({ blogPosts, popularPages }) => { > Policies - - Sales - Metadata