Subscription SC #2

dorin-iancu · 2023-09-01T10:38:06Z

The current PR contains 3 contracts:

one main "fees" contract, in which users deposit fees
one subscriber contract, which contains a common interface that has to be implemented by all contracts of its type. Each type of contract may have more than one action available. Daily, each contract will be called by an external service and it will perform the operation implemented, depending on the periodicity the user selected.
an example subscriber for metabonding

subscription-fee/src/lib.rs

subscription-fee/src/low_level_actions.rs

subscription-fee/src/pair_actions.rs

subscription-fee/src/service.rs

subscription-fee/src/daily_operations.rs

subscription-fee/src/service.rs

subscription-fee/src/daily_operations.rs

subscriber/src/user_tokens.rs

github-actions · 2023-09-11T08:00:46Z

Contract comparison - from fcaab6f to 3ec44bf

Path	size	has-allocator	has-format
mx-subscription-fee-rs
- subscription-fee/subscription-fee.wasm	232 ➡️ 18460 🔴	No	No
- metabonding-subscriber/metabonding-subscriber.wasm	N/A ➡️ 9998 ⚠️	N/A ➡️ No ⚠️	N/A ➡️ No ⚠️
- subscriber/subscriber.wasm	N/A ➡️ 1959 ⚠️	N/A ➡️ No ⚠️	N/A ➡️ No ⚠️

subscriber/src/service.rs

subscription-fee/src/fees.rs

subscriber/src/daily_operations.rs

metabonding-subscriber/src/lib.rs

subscription-fee/src/fees.rs

sasurobert · 2023-09-12T12:12:49Z

subscription-fee/src/fees.rs

+            tokens_to_withdraw.to_vec()
+        };
+
+        let user_fees_mapper = self.user_deposited_fees(caller_id);


mate 2 endpoints, withdrawFund and withdrawFees

sasurobert · 2023-09-13T07:36:45Z

subscriber/src/daily_operations.rs

+                fees_contract_address.clone(),
+            );
+            if subtract_result.is_err() {
+                return CONTINUE_OP;


if this is an error - the whole execution will fail anyway. No need for this check

Nope, this is a custom error. If I made it that way, the contract would get stuck if a user didn't deposit tokens for fees.

but if the ExecuteOnDestContext fails - the whole contract will fail anyway. So it does not matter if it is a custom error.

Nope, it's just an error, but not a VM panic. It simply says "hey, this didn't work".

sasurobert · 2023-09-13T07:36:52Z

subscriber/src/daily_operations.rs

+                &service_info,
+                user_data.borrow(),
+            );
+            if action_results.is_err() {


if this is an error - the whole execution will fail anyway. No need for this check

Same as above.

but if the ExecuteOnDestContext fails - the whole contract will fail anyway. So it does not matter if it is a custom error.

subscriber/src/daily_operations.rs

subscriber/src/user_tokens.rs

subscriber/src/daily_operations.rs

subscription-fee/src/subtract_payments.rs

claudiulataretu · 2023-09-13T19:38:27Z

subscription-fee/src/subtract_payments.rs

+            MyVeryOwnScResult::Err(_) => unreachable_unchecked(),
+        }
+    }
+}


Would be better to use addresses instead of IDs for arguments on endpoints. For external integrations is easier to work directly with address instead of ID

it is cheaper for the bot. to have IDs.

subscription-fee/src/fees.rs

CostinCarabas · 2023-09-14T06:38:57Z

subscription-fee/src/fees.rs

+            }
+
+            let mut opt_found_token_index = None;
+            for (index, user_token) in all_user_tokens.iter().enumerate() {


Can we remove this for by using a storage?

subscription-fee/src/fees.rs

subscription-fee/src/subtract_payments.rs

sasurobert · 2023-09-15T07:46:43Z

subscription-fee/src/subtract_payments.rs

+            MyVeryOwnScResult::Err(_) => unreachable_unchecked(),
+        }
+    }
+}


it is cheaper for the bot. to have IDs.

sasurobert · 2023-09-15T07:49:49Z

metabonding-subscriber/src/lib.rs

+        service_info: &ServiceInfo<<Self::SubSc as ContractBase>::Api>,
+        additional_data: &<Self as SubscriberContract>::AdditionalDataType,
+    ) -> Result<InterpretedResult<<Self::SubSc as ContractBase>::Api>, ()> {
+        let rewards_vec = sc.claim_metaboding_rewards(


we actually want boosted-rewards-subscriber - not metabonding. Where we claim boosted rewards from a set of farm/metastaking and feescollector addresses for that user.

Metabonding can stay, but we need a new contract where perform action will call claimBoostedRewards

This is only an example, it's a lot easier to integrate something like metabonding for testing purposes.

sasurobert · 2023-09-15T07:57:29Z

subscription-fee/src/service.rs

+
+        let mut services = ManagedVec::<Self::Api, _>::new();
+        for arg in args {
+            let (sc_address, energy_threshold, payment_type) = arg.into_tuple();


No energy threshold in this contract. This contract does not know about energy.

Still missing feature of registering multiple services from the same address.

Periodicity has to be saved here, and only allow to take_payment once per periodicity.

sasurobert · 2023-09-15T08:00:00Z

subscriber/src/service.rs

+    #[endpoint(registerService)]
+    fn register_service(
+        &self,
+        args: MultiValueEncoded<MultiValue3<ManagedAddress, BigUint, PaymentType<Self::Api>>>,


arguments are not energy_threshold. But payment and periodicity.

sasurobert · 2023-09-15T08:00:40Z

subscription-fee/src/subtract_payments.rs

+        let opt_user_address = self.user_id().get_address(user_id);
+        let user_address = opt_user_address?;
+        let user_energy = self.get_energy_amount(&user_address);
+        let cost = if user_energy >= service_info.energy_threshold {


no energy threshold here.

sasurobert · 2023-09-15T08:01:31Z

subscription-fee/src/subtract_payments.rs

+    #[endpoint(subtractPayment)]
+    fn subtract_payment(
+        &self,
+        service_index: usize,


so the caller can have multiple serviceIDs. Check if user is subscriber for that service ID and check the periodicity. Like when was the last time payment was subsctracted.

subscriber/src/daily_operations.rs

sasurobert · 2023-09-15T08:05:13Z

subscriber/src/daily_operations.rs

+            output_esdt.push(payment);
+        }
+
+        let action_results = SC::perform_action(


actually we do several actions per one user per one payment. Like we claim boosted rewards for all his farms and fees collector.

Each subscriber contract can do whatever they want in their perform_action implementation. If they want to perform several actions for one payment, that's fine.

sasurobert

Comments will be resolved in next PR.

dorin-iancu and others added 9 commits September 1, 2023 13:36

base fees logic

ad07ca6

temp commit

6167841

signed commits test

d510852

test again

a571a9b

views

cfd2fce

optimize

117d793

user subscription

339dd35

daily actions

7337823

finalized impl

3084872

sasurobert requested changes Sep 6, 2023

View reviewed changes

dorin-iancu added 4 commits September 7, 2023 14:07

temp commit - moved some stuff to different sc

968048e

fix bugs

9340695

updates

5f108f2

rename

5ff7274

michavie reviewed Sep 8, 2023

View reviewed changes

subscriber/src/user_tokens.rs Outdated Show resolved Hide resolved

michavie reviewed Sep 8, 2023

View reviewed changes

subscriber/src/user_tokens.rs Outdated Show resolved Hide resolved

dorin-iancu added 6 commits September 8, 2023 13:06

metabonding example

4d15ada

remove unused fields

1bf5363

metabonding subscriber example

aa70545

fix typo

998546c

Merge branch 'main' into subscription-sc

6d50f46

fix clippy

c0eb7f3

dorin-iancu added 7 commits September 11, 2023 11:14

fix index usage

d349af1

set current epoch

6a376ea

fix condition

edd6c6d

small fix

fbd1a1f

view

ca93aba

remove unused function

ce6304f

init test so action shut up

c687fd7

test + clippy

dbe137c

alyn509 reviewed Sep 12, 2023

View reviewed changes

subscriber/src/service.rs Outdated Show resolved Hide resolved

alyn509 reviewed Sep 12, 2023

View reviewed changes

subscription-fee/src/fees.rs Show resolved Hide resolved

alyn509 reviewed Sep 12, 2023

View reviewed changes

subscriber/src/daily_operations.rs Outdated Show resolved Hide resolved

alyn509 reviewed Sep 12, 2023

View reviewed changes

metabonding-subscriber/src/lib.rs Outdated Show resolved Hide resolved

dorin-iancu added 2 commits September 13, 2023 10:04

fixes after review

93beca7

rename endpoint

2e784a0

alyn509 approved these changes Sep 13, 2023

View reviewed changes

sasurobert requested changes Sep 13, 2023

View reviewed changes

fixes after review

d3fddf0

claudiulataretu reviewed Sep 13, 2023

View reviewed changes

CostinCarabas reviewed Sep 14, 2023

View reviewed changes

dorin-iancu added 6 commits September 14, 2023 11:08

move to separate function

1c2ca5e

remove unused code

7265b3b

move subscription logic

c946d7b

fix sending all egld

d9e9f33

rename

cdb8a40

rename again

148bd3c

dorin-iancu marked this pull request as ready for review September 14, 2023 11:16

dorin-iancu added 2 commits September 14, 2023 14:59

move cost to other sc

cd8cdda

rename

3ec44bf

sasurobert reviewed Sep 15, 2023

View reviewed changes

sasurobert approved these changes Sep 15, 2023

View reviewed changes

dorin-iancu merged commit 1d7f7c0 into main Sep 15, 2023
4 checks passed

dorin-iancu deleted the subscription-sc branch September 15, 2023 08:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Subscription SC #2

Subscription SC #2

dorin-iancu commented Sep 1, 2023 •

edited

Loading

github-actions bot commented Sep 11, 2023 •

edited

Loading

sasurobert Sep 12, 2023

sasurobert Sep 13, 2023

dorin-iancu Sep 13, 2023

sasurobert Sep 13, 2023 •

edited

Loading

dorin-iancu Sep 13, 2023

sasurobert Sep 13, 2023

dorin-iancu Sep 13, 2023

sasurobert Sep 13, 2023

claudiulataretu Sep 13, 2023

sasurobert Sep 15, 2023

CostinCarabas Sep 14, 2023

sasurobert Sep 15, 2023

sasurobert Sep 15, 2023

dorin-iancu Sep 15, 2023

sasurobert Sep 15, 2023

sasurobert Sep 15, 2023

sasurobert Sep 15, 2023

sasurobert Sep 15, 2023

sasurobert Sep 15, 2023

sasurobert Sep 15, 2023

sasurobert Sep 15, 2023

dorin-iancu Sep 15, 2023

sasurobert left a comment

Subscription SC #2

Subscription SC #2

Conversation

dorin-iancu commented Sep 1, 2023 • edited Loading

github-actions bot commented Sep 11, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sasurobert Sep 13, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sasurobert left a comment

Choose a reason for hiding this comment

dorin-iancu commented Sep 1, 2023 •

edited

Loading

github-actions bot commented Sep 11, 2023 •

edited

Loading

sasurobert Sep 13, 2023 •

edited

Loading