From e81c3652eb8298b473f99d1476bb5591b1c66f01 Mon Sep 17 00:00:00 2001 From: sergeypanin1994 Date: Tue, 7 Jan 2025 00:16:20 +0300 Subject: [PATCH 1/3] Fix typos and capitalization issues in documentation - Corrected "feed" to "fees" - Capitalized "ctf" to "CTF" for consistency - Fixed capitalization for "Polymarket" and "Gnosis Safe" - Updated "ERC1155 (ctf)" to "ERC1155 (CTF)" --- docs/CTFExchange.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/CTFExchange.md b/docs/CTFExchange.md index 2debc34..cebbb62 100644 --- a/docs/CTFExchange.md +++ b/docs/CTFExchange.md @@ -14,8 +14,8 @@ Parameters: address _collateral // ERC20 collateral asset (USDC) address _ctf // ERC1155 outcome tokens contract (gnosis conditional tokens framework) address _proxyFactory // Polymarket proxy factory -address _safeFactory // Gnosis safe factory contract -address _feeReceiver // account to accumulate feed to +address _safeFactory // Gnosis Safe factory contract +address _feeReceiver // account to accumulate fees to ``` ## `pauseTrading` @@ -138,8 +138,8 @@ Registers a tokenId, its complement and its conditionId for trading. Parameters: ```java -uint256 token // The ERC1155 (ctf) tokenId being registered -uint256 complement // The ERC1155 (ctf) token ID of the complement of token +uint256 token // The ERC1155 (CTF) tokenId being registered +uint256 complement // The ERC1155 (CTF) token ID of the complement of token bytes32 // The corresponding CTF conditionId ``` Requirements: From 2df022f98daa63a2dbf58e00d18c7cce3b4353c9 Mon Sep 17 00:00:00 2001 From: sergeypanin1994 Date: Tue, 7 Jan 2025 00:19:19 +0300 Subject: [PATCH 2/3] Fix typos and capitalization issues - Corrected "non-custodially" to "non-custodial" - Fixed spelling of "Completments" to "Complements" --- docs/Overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Overview.md b/docs/Overview.md index b154af4..d3325cb 100644 --- a/docs/Overview.md +++ b/docs/Overview.md @@ -2,7 +2,7 @@ ## Overview -The `CTFExchange` contract facilitates atomic swaps between binary outcome tokens (ERC1155) and the collateral asset (ERC20). It is intended to be used in a hybrid-decentralized exchange model wherein there is an operator that provides matching/ordering/execution services while settlement happens on-chain,non-custodially according to instructions in the form of signed order messages. The CTF exchange allows for matching operations that include a mint/merge operation which allows orders for complementary outcome tokens to be crossed. Orders are represented as signed typed structured data (EIP712). Additionally, the CTFExchange implements symmetric fees. When orders are matched, one side is considered the maker and the other side is considered the taker. The relationship is always either one to one or many to one (maker to taker) and any price improvement is captured by the taking agent. +The `CTFExchange` contract facilitates atomic swaps between binary outcome tokens (ERC1155) and the collateral asset (ERC20). It is intended to be used in a hybrid-decentralized exchange model wherein there is an operator that provides matching/ordering/execution services while settlement happens on-chain,non-custodial according to instructions in the form of signed order messages. The CTF exchange allows for matching operations that include a mint/merge operation which allows orders for complementary outcome tokens to be crossed. Orders are represented as signed typed structured data (EIP712). Additionally, the CTFExchange implements symmetric fees. When orders are matched, one side is considered the maker and the other side is considered the taker. The relationship is always either one to one or many to one (maker to taker) and any price improvement is captured by the taking agent. ## Matching Scenarios From d5877829b3789f6c9d76e6a678935acd78539475 Mon Sep 17 00:00:00 2001 From: sergeypanin1994 Date: Tue, 7 Jan 2025 00:20:23 +0300 Subject: [PATCH 3/3] Fix typo and improve phrasing - Corrected "non-custodially" to "non-custodial" --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f94d6d8..bfcc3bf 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ The Polymarket CTF Exchange is an exchange protocol that facilitates atomic swaps between [Conditional Tokens Framework(CTF)](https://docs.gnosis.io/conditionaltokens/) ERC1155 assets and an ERC20 collateral asset. -It is intended to be used in a hybrid-decentralized exchange model wherein there is an operator that provides offchain matching services while settlement happens on-chain, non-custodially. +It is intended to be used in a hybrid-decentralized exchange model wherein there is an operator that provides offchain matching services while settlement happens on-chain, non-custodial. ## Documentation