chain release2.9 compatibility Grace Period and overdue #3387

0oM4R · 2024-09-07T16:45:30Z

Description

We have new accurate way to resume/unlock contracts on tfchain2.9, this pull request is for replace the old way as it is no longer supported.

General idea:

Now the amount required to resume the contract is described as Overdue.
The overdue amount basically is the sum of three parts:

Total over draft: is the sum of additional overdraft and standard overdraft.
Unbilled NU: is the unbilled amount of network usage.
The estimated cost of the contract for the total period: this part is dependent on the contract type and if the contract is on a rented node or not.

Note:

The total period is the time since the last billing added to the allowance period.

If the contract is a rent contract, will add both of ipv4 cost and the total overdue of all associated contracts.

Changes

Please node: you may notice that we have multiple functions that generally do the same thing but require different arguments.
for example: we need some information that is already in the contract type,
so instead of requesting the contract in side the function we are passing it.
but in some cases we only have the contract id? we provide a function that take the contract id and then request the contract then pass it to the inner function.

TFChain client

Fixed the generateTypes.bash:

the old script required to have ts-node installed, now we can run those commands using yarn.

In contracts, we add some functions that help in grid client new features.

Grid client:

add deprecated annotation to the no longer supported functions that are associated with locked amount.
Calculator module: added a function to calculate the name pricing.
Contract module:
- added some functions that calculate overdue, you can pass the contract, or the contract id.
- add functions to unlock contracts, all contracts, and batch unlock using array of contracts or array of contractss ids
- we are using gridproxy in unlock contracts

Dashboard

support new functions in grid client, refactor, and remove the deprecated gird client functions.
we have some changes in the flow:

If the user select node contracts, and some of them are on a rent contract, we will show the rent contract id with the selected contracts
if use click on grace period chip of node contract with ipv4 on rented node the content of the dialog depends on the rent contract state:
- if the rent contract state is Created : will get the node contract overdue, and user will be able to unlock the contract.
- If on Grace period: will show a message that you will have to check the rent contract and unlock it.

fix loading spinner in loading locked amount details:

Related Issues

#3340
#3364

Tested Scenarios

show contract/s cost : this will be nearly from pricing calculator if the contract got billed right before moving to the grace period as in this case overdue will be small for example, name contract cost should be about 0.025 tfts
select node contracts on rented node that its contract on grace period,
unlock all contracts associated with rent contract: in this case to verify that the node contract got billed, use smarContractModule/contractPaymentState call, the additional and standred overdraft should be 0
Unlock single or multiple contracts
in any case we should'n have a contract got billed twice: you can add log line to log the ids in batchUnlock contracts
Tips:
To send contract to a grace period, you need to follow some steps
1- empty you walet, this can be done by polkadot UI Balances/TransferAll
2- get the contract Id, must be billable one like rent contract or node contract on shared node, name contract, and call smarContractsModule/billcontractForBlock using any other funded account.
to send node contract with public ip on rented node to grace period and keep it's rent contract is on created state
- fund you wallet, and call bill contract for block for the rent contract,
- then send the node contract with ipv4 only to grace period as mentioned

Documentation PR

For UI changes, Please provide the Documetation PR on info_grid

Checklist

- a method to get NU billing information - a method to get contract payment state - a method to get used resources by the node contract - some related interfaces

enhance code readablity. reduce number of requests by passing the contract info to all chiled functions

- use proxy url in unlockMycontracts - refactor unlockContracts to accept array of contracts - add function to unlock contracts by their ids

- add function that takes only contract to unlock it - add calculate overdue functions

mUSD converter will return the price in mTFT fix unique name price calc fix imports

- add contracts on rented node to the rent node overdue

it is storing the rent contract on a map by the node id, and ignore the unwanted calculations

unlock dialog now will check if the node contract on rented node or not; if so will retrive the rent contract cost and store the and will avoid duplication

…d with selected contracts

sameh-farouk · 2024-09-30T14:09:00Z

@0oM4R I attempted a quick test, but it didn't go well.

sameh-farouk · 2024-09-30T14:13:22Z

Another point, it seems you haven't incorporated the changes discussed in the tg group yet.

Unlock All/ Unlock -> Resume All / Resume
Locked Balance -> On hold
Show in UI: Available and On hold

…into development_chain_release2.9

0oM4R · 2024-09-30T14:57:06Z

Another point, it seems you haven't incorporated the changes discussed in the tg group yet.

Unlock All/ Unlock -> Resume All / Resume
Locked Balance -> On hold
Show in UI: Available and On hold

there is a separate issue for it #3400

0oM4R · 2024-09-30T15:02:11Z

works fine with me but we should handle the zero tft case in the ui

@0oM4R I attempted a quick test, but it didn't go well.

sameh-farouk · 2024-09-30T15:20:16Z

works fine with me but we should handle the zero tft case in the ui

Sorry, My bad.
I didn't pull the latest changes. So I will give it another try tomorrow.

sameh-farouk · 2024-10-02T14:56:09Z

Calculations looks much better now.

Test failed

…rting cost per second

0oM4R · 2024-10-03T11:58:53Z

Test report:
will update this comment with the tested scenarios in details

Rent contract without any node contracts on it

the allowance window in the next scenarios is 60 seconds

skip the node contracts on rented nodes as it already calculated in rent contract

we were ignoring the elapsed seconds for node contracts and we assume that it is the same as rent contract

reorder the calculation logic to be easier in debugging

pass the contracts by id as the contracts do not have the public_ips_number field

…nction this will be needed for UI

0oM4R added 30 commits September 6, 2024 07:07

Refactor: add yarn to script to avoid errors

4008755

Feat: add some methods and interfaces

50e3d5a

- a method to get NU billing information - a method to get contract payment state - a method to get used resources by the node contract - some related interfaces

Feat: calculate unique name prcice

fa43de3

chore: inhance docstirng

593914d

Feat: support contract payment state calculations

8693051

Refactor: unlock contracts to use new overdue calculations

9af58da

Refactor:

46b6166

enhance code readablity. reduce number of requests by passing the contract info to all chiled functions

chore: inhance imports

6ae49d0

Refactor: unlock contracts

c655eb6

- use proxy url in unlockMycontracts - refactor unlockContracts to accept array of contracts - add function to unlock contracts by their ids

add overdue details interfaces

9bc59cf

chore: contract overdue

e0cd248

- add function that takes only contract to unlock it - add calculate overdue functions

chore: expose get over due amount by the contract info only

8d72c5c

fix: remove duplicated call

c5f6de8

refactor:

eb1a7fd

mUSD converter will return the price in mTFT fix unique name price calc fix imports

WIP: support overdue changes on contracts list in dashboard

200b46c

refactor: fix unique name contract

e1d0363

wip fix calculations

8f2b5b7

feat: support Payment state

f29a977

- add contracts on rented node to the rent node overdue

chore: clean up

e80eae6

refactor: enhance contract lock state

a496e73

it is storing the rent contract on a map by the node id, and ignore the unwanted calculations

refactor: enhance contract lock

a1910e2

unlock dialog now will check if the node contract on rented node or not; if so will retrive the rent contract cost and store the and will avoid duplication

refactor: fix is on rented node flag

c161781

refactor: call the associated rent contract on unlock rent contracts

a946efe

feat: show the rent contract that will be unlocked as it is associate…

aa0e95f

…d with selected contracts

Style: fix loading spinner in lock dialogs

d1e1889

fix: build

976695d

fix: passing contracts to client

3eaf6f5

docs: add deprecated annotation

ca76686

return the contract cost whatever if it is on a rented node or not

f650c2f

docs: WIP adding docstrings

a3f6a6f

0oM4R marked this pull request as draft September 19, 2024 15:17

0oM4R added 2 commits September 22, 2024 12:33

Chore: add node extra fees to rent contract cost

ee14685

refactor: include premuim price for certified nodes in the unbuiled nu

b2e8914

0oM4R marked this pull request as ready for review September 22, 2024 12:27

0oM4R requested a review from sameh-farouk September 22, 2024 12:27

Merge branch 'development' of github.com:threefoldtech/tfgrid-sdk-ts …

60d3ed4

…into development_chain_release2.9

chore: set decimals to 7 in convert tft price

69397c3

sameh-farouk previously approved these changes Oct 2, 2024

View reviewed changes

refactor: convert the monthly cost to avoid missing decimals on conve…

efb365c

…rting cost per second

0oM4R added 8 commits October 7, 2024 12:03

fix: get total overdue

cd8d087

skip the node contracts on rented nodes as it already calculated in rent contract

refactor: calculate node contract on rented node

829718d

we were ignoring the elapsed seconds for node contracts and we assume that it is the same as rent contract

refactor

5d63c81

reorder the calculation logic to be easier in debugging

refactor:

3abb1a5

pass the contracts by id as the contracts do not have the public_ips_number field

fix: reset total overdue on refresh

b2ec2e4

reset rentcontract on reset table

8e482a8

Fix: add premium price for ip price on rent node

7026c2c

Chore: remove unused functions

0714187

0oM4R mentioned this pull request Oct 9, 2024

inconsistent node certification type between chain and graphql threefoldtech/tfchain_graphql#193

Open

0oM4R and others added 3 commits October 10, 2024 17:25

Chore: set to fixed point 15 and fix the error msg

aed21b5

Chore: include node contract on rented node in the getTotalOverDue fu…

0a4aab6

…nction this will be needed for UI

Style: rephrase unlock dialog msg

8667aa0

0oM4R requested a review from sameh-farouk October 14, 2024 14:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chain release2.9 compatibility Grace Period and overdue #3387

chain release2.9 compatibility Grace Period and overdue #3387

0oM4R commented Sep 7, 2024 •

edited

Loading

sameh-farouk commented Sep 30, 2024 •

edited

Loading

sameh-farouk commented Sep 30, 2024

0oM4R commented Sep 30, 2024

0oM4R commented Sep 30, 2024

sameh-farouk commented Sep 30, 2024

sameh-farouk commented Oct 2, 2024

0oM4R commented Oct 3, 2024 •

edited

Loading

chain release2.9 compatibility Grace Period and overdue #3387

Are you sure you want to change the base?

chain release2.9 compatibility Grace Period and overdue #3387

Conversation

0oM4R commented Sep 7, 2024 • edited Loading

Description

General idea:

Changes

TFChain client

Grid client:

Dashboard

Related Issues

Tested Scenarios

Documentation PR

Checklist

sameh-farouk commented Sep 30, 2024 • edited Loading

sameh-farouk commented Sep 30, 2024

0oM4R commented Sep 30, 2024

0oM4R commented Sep 30, 2024

sameh-farouk commented Sep 30, 2024

sameh-farouk commented Oct 2, 2024

0oM4R commented Oct 3, 2024 • edited Loading

Rent contract without any node contracts on it

the allowance window in the next scenarios is 60 seconds

0oM4R commented Sep 7, 2024 •

edited

Loading

sameh-farouk commented Sep 30, 2024 •

edited

Loading

0oM4R commented Oct 3, 2024 •

edited

Loading