fix(readme): Enhance readme #113

InversionSpaces · 2023-10-12T14:16:35Z

Separate command from outputs so it is easy to copy commands
Update deployment guide
Add warning about previous deployment info removal

README.md

boneyard93501 · 2023-10-12T18:42:26Z

README.md

@@ -58,7 +58,7 @@ If you don't have Fluence CLI installed, do:
 npm -g i @fluencelabs/cli@unstable
 ```

-Before you proceed, you  should have, say, three RPC endpoint urls, e.g., Infura, Alchemy and QuickNode, for the same EVM-based chain you are using in your dAPP. Update the `configs/quickstart_config.json` by providing your endpoint urls and ignore the rest of the parameters for now:
+Before you proceed, you should have, say, three RPC endpoint urls, e.g., Infura, Alchemy and QuickNode, for the same EVM-based chain you are using in your dAPP. Update the `configs/quickstart_config.json` by providing your endpoint urls and ignore the rest of the parameters for now:


Suggested change

Before you proceed, you should have, say, three RPC endpoint urls, e.g., Infura, Alchemy and QuickNode, for the same EVM-based chain you are using in your dAPP. Update the `configs/quickstart_config.json` by providing your endpoint urls and ignore the rest of the parameters for now:

Before you proceed, you should have, say, three RPC endpoint urls, e.g., Infura, Alchemy and Ankr, for the same EVM-based chain you are using in your dAPP. Update the `configs/quickstart_config.json` by providing your endpoint urls and ignore the rest of the parameters for now:

the method selection should be addressed. currently, round-robin is suggested but it could be quorum, which requires specifying the quorumNumber.

Why substitute QuickNode with Ankr?

Other algorithms are described later in the doc
Quickstart is about getting default thing working as fast as possible
Should we describe other algorithms right here?

Also quorum does not require quorumNumber, it has a default of 2

Why substitute QuickNode with Ankr?

they made the use of a free account very difficult with a lot of limitations.

Other algorithms are described later in the doc Quickstart is about getting default thing working as fast as possible Should we describe other algorithms right here?

up to you. i actually think the entire document should be redone and all your work is getting us there. so much appreciated. re algo descritions, yes, that could work. want to give it a try?

boneyard93501 · 2023-10-12T18:45:50Z

README.md

@@ -58,7 +58,7 @@ If you don't have Fluence CLI installed, do:
 npm -g i @fluencelabs/cli@unstable
 ```

-Before you proceed, you  should have, say, three RPC endpoint urls, e.g., Infura, Alchemy and QuickNode, for the same EVM-based chain you are using in your dAPP. Update the `configs/quickstart_config.json` by providing your endpoint urls and ignore the rest of the parameters for now:
+Before you proceed, you should have, say, three RPC endpoint urls, e.g., Infura, Alchemy and QuickNode, for the same EVM-based chain you are using in your dAPP. Update the `configs/quickstart_config.json` by providing your endpoint urls and ignore the rest of the parameters for now:


the method selection should be addressed. currently, round-robin is suggested but it could be quorum, which requires specifying the quorumNumber.

README.md

boneyard93501 · 2023-10-12T19:00:02Z

README.md

 ![Sign TX](./images/sign_tx_metamask.png)
-* once you signed the transaction and the contract was successfully updated, we are done! (6)
+* once you sign transactions, the deal is created and the workers join the deal, deploying your services (5)
+* finally, deployment information is saved for future use in Aqua scripts (6)


might be a good time to demonstrate the fluence workers log command and output.

Co-authored-by: folex <0xdxdy@gmail.com>

boneyard93501 · 2023-10-13T22:34:59Z

README.md


 To get rid of the demo project for now, use `fluence module remove` to unlink the module from the *fluence.yaml* and *service.yaml* files; the old *rm -r <path/demo>* gets rid of the code template.

 ### Deploying A Service

-With a service, in this case the *eth-rpc* service, ready for deployment, we simply use the `fluence deal deploy` command:
+> :warning: **Warning**: For quickstart, services are already deployed for you. But if you want to deploy services in this repository yourself, you should remove old deployment information first:


this isn't resolving right:

How do you view this? I use "show rich diff" on this PR in github UI and I get:

Github has its own markdown flavour

README.md

boneyard93501 · 2023-10-14T00:05:21Z

README.md


 ## Summary

-fRPC is a design pattern to efficiently mitigate risks inherent in centralized RPC providers for dApps using Fluence's decentralized serverless compute protocol. fRPC Substrate is a basic implementation of the fRPC design pattern that dApp users can use put of the box with no changes to their frontend. Moreover, Fluence is sponsoring hackathons, like EthDenver 2023, for developers to try the substrate and hack on and expand on the control algorithms provided to serve their needs and provide improvements to the community.
+fRPC is a design pattern to efficiently mitigate risks inherent in centralized RPC providers for dApps using Fluence's decentralized serverless compute protocol. fRPC Substrate is a basic implementation of the fRPC design pattern that dApp users can use out of the box with no changes to their frontend. Moreover, Fluence is sponsoring hackathons, like EthDenver 2023, for developers to try the substrate and hack on and expand on the control algorithms provided to serve their needs and provide improvements to the community.

 For support, to discuss your ideas or to schedule presentations of your solutions to the Fluence and fRPC community at large, reach out in [discord]("https://fluence.chat") or [telegram](https://t.me/fluence_project).


might as well delete that.

we haven't formalized the design pattern, the hackathon references are outdated and the document needs to be reworked for future hackathons. so not much point confusing people with incomplete or outdated info.
but if you find that paragraph useful, just remove

Moreover, Fluence is sponsoring hackathons, like EthDenver 2023, for developers to try the substrate and hack on and expand on the control algorithms provided to serve their needs and provide improvements to the community.

for now.

README.md

boneyard93501 · 2023-10-14T00:41:39Z

the yaml file overview content is pretty much all outdated, e.g., fluence.yaml section. @InversionSpaces do you want to keep that section?

Co-authored-by: boneyard93501 <4523011+boneyard93501@users.noreply.github.com>

InversionSpaces · 2023-10-16T10:58:39Z

I believe screenshot of metamask should be updated as it shows aurora testsnet, but we use mumbai testnet?

boneyard93501 · 2023-10-16T22:37:28Z

awesome. thank you.

InversionSpaces · 2023-10-23T15:18:26Z

Okay, fluence deal logs does not work still.
Created a task to add it later: DXJ-512
Will merge now

InversionSpaces force-pushed the fix/readme branch from 5c0ed6e to 66f71ee Compare October 12, 2023 14:27

Separate commands

b09fdb7

InversionSpaces force-pushed the fix/readme branch from 66f71ee to b09fdb7 Compare October 12, 2023 14:35

InversionSpaces added 4 commits October 12, 2023 15:07

Update deploy guide

95b0f6f

Add command

2065e63

service -> deal

31519c8

uri -> uris

1b0f679

InversionSpaces requested review from folex, boneyard93501 and akim-bow October 12, 2023 15:13

InversionSpaces marked this pull request as ready for review October 12, 2023 15:27

folex reviewed Oct 12, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

folex reviewed Oct 12, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

folex reviewed Oct 12, 2023

View reviewed changes

README.md Show resolved Hide resolved

boneyard93501 reviewed Oct 12, 2023

View reviewed changes

InversionSpaces and others added 5 commits October 13, 2023 10:17

Add missing bash

f8e431e

Co-authored-by: folex <0xdxdy@gmail.com>

Grammar

18e317d

Two transactions clarification

6125f49

Fix spelling

7d0b84d

Redeploy comment

1be33f2

InversionSpaces requested review from folex and boneyard93501 October 13, 2023 11:32

boneyard93501 reviewed Oct 13, 2023

View reviewed changes

boneyard93501 reviewed Oct 14, 2023

View reviewed changes

InversionSpaces and others added 4 commits October 16, 2023 10:24

Add comment on transaction signing

c20221f

Update README.md

8976386

Co-authored-by: boneyard93501 <4523011+boneyard93501@users.noreply.github.com>

Update README.md

87fc619

Co-authored-by: boneyard93501 <4523011+boneyard93501@users.noreply.github.com>

Update README.md

af5cf72

Co-authored-by: boneyard93501 <4523011+boneyard93501@users.noreply.github.com>

InversionSpaces and others added 3 commits October 16, 2023 12:34

Update README.md

c2e4265

Co-authored-by: boneyard93501 <4523011+boneyard93501@users.noreply.github.com>

Comment on deal redeployment

777d01b

Remove CLI configs reference

d0dbdd1

InversionSpaces requested a review from boneyard93501 October 16, 2023 10:58

InversionSpaces added 9 commits October 16, 2023 14:19

Update metamask screenshot

b05d4d2

Remove hackathon references

79610cc

QuickNode -> Ankr

d8735e9

Remove hackathon references

1d3419e

Fix Ankr Goerli endpoint

5ec5c33

Fix screenshot

58e9757

Remove unnecessary paragraph

e07e926

Change section name

1dcc2f0

Enhance algorithms description

7b37ab2

InversionSpaces force-pushed the fix/readme branch from f358c4c to 7b37ab2 Compare October 16, 2023 15:17

Merge branch 'main' into fix/readme

12b0681

InversionSpaces requested a review from meph October 16, 2023 15:26

boneyard93501 approved these changes Oct 16, 2023

View reviewed changes

InversionSpaces merged commit bf49ebf into main Oct 23, 2023
3 checks passed

InversionSpaces deleted the fix/readme branch October 23, 2023 15:18

fluencebot mentioned this pull request Oct 23, 2023

chore(main): release 0.0.19 #120

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(readme): Enhance readme #113

fix(readme): Enhance readme #113

InversionSpaces commented Oct 12, 2023 •

edited

Loading

boneyard93501 Oct 12, 2023

boneyard93501 Oct 12, 2023

InversionSpaces Oct 13, 2023

InversionSpaces Oct 13, 2023

InversionSpaces Oct 13, 2023

boneyard93501 Oct 16, 2023

boneyard93501 Oct 16, 2023

boneyard93501 Oct 12, 2023

boneyard93501 Oct 12, 2023

boneyard93501 Oct 13, 2023

InversionSpaces Oct 16, 2023

boneyard93501 Oct 14, 2023

InversionSpaces Oct 16, 2023

boneyard93501 Oct 16, 2023 •

edited

Loading

boneyard93501 commented Oct 14, 2023

InversionSpaces commented Oct 16, 2023

boneyard93501 commented Oct 16, 2023

InversionSpaces commented Oct 23, 2023

	Before you proceed, you should have, say, three RPC endpoint urls, e.g., Infura, Alchemy and QuickNode, for the same EVM-based chain you are using in your dAPP. Update the `configs/quickstart_config.json` by providing your endpoint urls and ignore the rest of the parameters for now:
	Before you proceed, you should have, say, three RPC endpoint urls, e.g., Infura, Alchemy and Ankr, for the same EVM-based chain you are using in your dAPP. Update the `configs/quickstart_config.json` by providing your endpoint urls and ignore the rest of the parameters for now:

fix(readme): Enhance readme #113

fix(readme): Enhance readme #113

Conversation

InversionSpaces commented Oct 12, 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

boneyard93501 Oct 16, 2023 • edited Loading

Choose a reason for hiding this comment

boneyard93501 commented Oct 14, 2023

InversionSpaces commented Oct 16, 2023

boneyard93501 commented Oct 16, 2023

InversionSpaces commented Oct 23, 2023

InversionSpaces commented Oct 12, 2023 •

edited

Loading

boneyard93501 Oct 16, 2023 •

edited

Loading