PP-668/update-devportal by franciscotobar · Pull Request #2 · franciscotobar/devportal

franciscotobar · 2023-02-15T03:25:07Z

What

Update rif-relay guides
Update rif-relay about

Why

Replace the old version of the libraries with the new one

Refs

(PP-668)[https://rsklabs.atlassian.net/browse/PP-668]

ironFe93

Overall pretty good, left some suggestions

ironFe93 · 2023-02-17T14:09:15Z

+The `Relay Client` its a component from the RIF Relay Client library that helps to build relay request, search for a server and send the request via http protocol. 

-To simplify the integration process a SDK was developed, the SDK is a library that needs to be used from a dApp that will provide us a way to sign transactions.
+To create a `Relay Client` we need to follow next steps:


Suggested change

To create a `Relay Client` we need to follow next steps:

To create a `Relay Client` we need to follow the next steps:

ironFe93 · 2023-02-17T14:10:12Z

+
+### Account Manager
+
+The `Account Manager` manager its a singleton component from the RIF Relay Client library that helps to sign the relay transactions.  This component can sign the transactions with an internal account that was previously added or using a wallet provider like [metamask](https://metamask.io/). The `Account Manager` will look first for internal account's and if none is found, will try to use the provider that was [previously setup](/guides/rif-relay/integrate/#relay-client).


Suggested change

The `Account Manager` manager its a singleton component from the RIF Relay Client library that helps to sign the relay transactions. This component can sign the transactions with an internal account that was previously added or using a wallet provider like [metamask](https://metamask.io/). The `Account Manager` will look first for internal account's and if none is found, will try to use the provider that was [previously setup](/guides/rif-relay/integrate/#relay-client).

The `Account Manager` manager is a singleton component from the RIF Relay Client library that helps to sign the relay transactions. This component can sign the transactions with an internal account that was previously added or using a wallet provider like [metamask](https://metamask.io/). The `Account Manager` will look first for internal accounts and if none is found, will try to use the provider that was [previously setup](/guides/rif-relay/integrate/#relay-client).

ironFe93 · 2023-02-17T14:10:31Z

+
+The `Account Manager` accepts [Ethers V5 Wallets](https://docs.ethers.org/v5/api/signer/#Wallet) as internal accounts.  
+
+To interact with the `Account Manager` we need to the next steps:


Suggested change

To interact with the `Account Manager` we need to the next steps:

To interact with the `Account Manager` we need to follow the next steps:

ironFe93 · 2023-02-17T14:12:01Z

-  * **RSK_CHAIN_ID**: The RSK node chain ID which is running (e.g. `33`).
-  * **RIF_RELAY_SERVER_URL**: The RIF Relay Server URL (e.g. `http://localhost:8090`).
-  * **RSK_NODE_ENDPOINT**: The RSK node endpoint which is running (e.g. `http://localhost:4444`).
+  * **INTERNAL_ACCOUNT_OBJECT**: Ethers V4 Wallet object.


Line 93 states that the Account Manager accepts V5 wallets.

ironFe93 · 2023-02-17T14:25:34Z

-  * **SMART_WALLET**: the generated smart wallet from the deployment process.
-  * **TOKEN_ADDRESS**: the token contract address.
-  * **AMOUNT_OF_TOKENS**: string containing the amount of tokens in decimal unit.
+  * **EOA**: External Owned Account, the owner of the smart wallet.


Suggested change

* **EOA**: External Owned Account, the owner of the smart wallet.

* **EOA**: Externally Owned Account, the owner of the smart wallet.

ironFe93

still good, found some more suggestions.

ironFe93 · 2023-02-17T15:00:32Z

+    }
+  ```
+
+Were each key from `request` is:


Suggested change

Were each key from `request` is:

Where each key from `request` is:

ironFe93 · 2023-02-17T15:00:42Z

+      }
+    }
+  ```
+Were each key from `request` is:


Suggested change

Were each key from `request` is:

Where each key from `request` is:

ironFe93 · 2023-02-17T15:00:57Z

+  * **validUntilTime**: Transaction expiration time in seconds.
+
+
+Were each key from `relayData` is:


Suggested change

Were each key from `relayData` is:

Where each key from `relayData` is:

ironFe93 · 2023-02-17T15:06:12Z

-  * **SMART_WALLET_INDEX**: the index that we would like to use to generate the smart wallet.
-  * **TOKEN_ADDRESS**: the token contract address.
-  * **AMOUNT_OF_TOKENS**: string containing the amount of tokens in decimal unit.
+  * **EOA**: External Owned Account, the owner of the smart wallet.


Suggested change

* **EOA**: External Owned Account, the owner of the smart wallet.

* **EOA**: Externally Owned Account, the owner of the smart wallet.

ironFe93 · 2023-02-17T15:07:47Z

+
+### Native Holder Smart Wallet
+
+The `native holder smart wallet` it's a `smart wallet` that was designed to have interactions outside the RIF Relay system. This means that can hold native currency as it's name describe it.


Suggested change

The `native holder smart wallet` it's a `smart wallet` that was designed to have interactions outside the RIF Relay system. This means that can hold native currency as it's name describe it.

The `native holder smart wallet` is a `smart wallet` that was designed to have interactions outside the RIF Relay system. This means that it can hold native currency as it's name describes.

ironFe93 · 2023-02-17T15:08:07Z

+
+The `native holder smart wallet` it's a `smart wallet` that was designed to have interactions outside the RIF Relay system. This means that can hold native currency as it's name describe it.
+
+The behavior of the `native holder smart wallet` its the same as the `smart wallet` with the difference that the native currency will not be transferred back to the owner after each transaction and can dispose the usage of the native currency.


Suggested change

The behavior of the `native holder smart wallet` its the same as the `smart wallet` with the difference that the native currency will not be transferred back to the owner after each transaction and can dispose the usage of the native currency.

The behavior of the `native holder smart wallet` is the same as the `smart wallet` with the difference that the native currency will not be transferred back to the owner after each transaction and can dispose the usage of the native currency.

ironFe93 · 2023-02-17T15:08:24Z

+
+### Custom Smart Wallet
+
+The `custom smart wallet` it's a `smart wallet` that was designed to execute custom logic after each transaction. The custom logic it's created at the moment of the contract deployment and can be executed on each transaction. 


Suggested change

The `custom smart wallet` it's a `smart wallet` that was designed to execute custom logic after each transaction. The custom logic it's created at the moment of the contract deployment and can be executed on each transaction.

The `custom smart wallet` is a `smart wallet` that was designed to execute custom logic after each transaction. The custom logic is created at the moment of the contract deployment and can be executed on each transaction.

ironFe93 · 2023-02-17T15:09:17Z

-
 ### Relay Client
-This is a typescript library to interact with the RIF Relay system. It provides APIs to find a relay, and to send transactions through it. It also gives access to expose methods from Relay Common to interact with the blockchain.
+This is a typescript library to interact with the RIF Relay system. It provides APIs to find a relay, and to send transactions through it. It also expose methods to interact with the blockchain.


Suggested change

This is a typescript library to interact with the RIF Relay system. It provides APIs to find a relay, and to send transactions through it. It also expose methods to interact with the blockchain.

This is a typescript library to interact with the RIF Relay system. It provides APIs to find a relay, and to send transactions through it. It also exposes methods to interact with the blockchain.

antomor

It required some changes that were applied here

antomor · 2023-02-21T14:08:09Z

This PR could be closed in favour of this.

franciscotobar changed the title ~~refactor: first commit~~ PP-668/update-devportal Feb 16, 2023

franciscotobar force-pushed the PP-668/update-devportal branch from 9cfb67f to e185eba Compare February 16, 2023 21:26

franciscotobar marked this pull request as ready for review February 16, 2023 21:26

ironFe93 approved these changes Feb 17, 2023

View reviewed changes

docs: ethers update

b9199d6

franciscotobar force-pushed the PP-668/update-devportal branch from 5c0b831 to b9199d6 Compare February 17, 2023 17:21

antomor suggested changes Feb 21, 2023

View reviewed changes

	To create a `Relay Client` we need to follow next steps:
	To create a `Relay Client` we need to follow the next steps:


		### Account Manager

		The `Account Manager` manager its a singleton component from the RIF Relay Client library that helps to sign the relay transactions. This component can sign the transactions with an internal account that was previously added or using a wallet provider like [metamask](https://metamask.io/). The `Account Manager` will look first for internal account's and if none is found, will try to use the provider that was [previously setup](/guides/rif-relay/integrate/#relay-client).


		The `Account Manager` accepts [Ethers V5 Wallets](https://docs.ethers.org/v5/api/signer/#Wallet) as internal accounts.

		To interact with the `Account Manager` we need to the next steps:

	* EOA: External Owned Account, the owner of the smart wallet.
	* EOA: Externally Owned Account, the owner of the smart wallet.

	Were each key from `request` is:
	Where each key from `request` is:

		* validUntilTime: Transaction expiration time in seconds.


		Were each key from `relayData` is:

	Were each key from `relayData` is:
	Where each key from `relayData` is:


		### Native Holder Smart Wallet

		The `native holder smart wallet` it's a `smart wallet` that was designed to have interactions outside the RIF Relay system. This means that can hold native currency as it's name describe it.

	The `native holder smart wallet` it's a `smart wallet` that was designed to have interactions outside the RIF Relay system. This means that can hold native currency as it's name describe it.
	The `native holder smart wallet` is a `smart wallet` that was designed to have interactions outside the RIF Relay system. This means that it can hold native currency as it's name describes.


		The `native holder smart wallet` it's a `smart wallet` that was designed to have interactions outside the RIF Relay system. This means that can hold native currency as it's name describe it.

		The behavior of the `native holder smart wallet` its the same as the `smart wallet` with the difference that the native currency will not be transferred back to the owner after each transaction and can dispose the usage of the native currency.


		### Custom Smart Wallet

		The `custom smart wallet` it's a `smart wallet` that was designed to execute custom logic after each transaction. The custom logic it's created at the moment of the contract deployment and can be executed on each transaction.

	The `custom smart wallet` it's a `smart wallet` that was designed to execute custom logic after each transaction. The custom logic it's created at the moment of the contract deployment and can be executed on each transaction.
	The `custom smart wallet` is a `smart wallet` that was designed to execute custom logic after each transaction. The custom logic is created at the moment of the contract deployment and can be executed on each transaction.

	This is a typescript library to interact with the RIF Relay system. It provides APIs to find a relay, and to send transactions through it. It also expose methods to interact with the blockchain.
	This is a typescript library to interact with the RIF Relay system. It provides APIs to find a relay, and to send transactions through it. It also exposes methods to interact with the blockchain.

Conversation

franciscotobar commented Feb 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

Why

Refs

Uh oh!

ironFe93 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ironFe93 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

antomor left a comment

Choose a reason for hiding this comment

Uh oh!

antomor commented Feb 21, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

franciscotobar commented Feb 15, 2023 •

edited

Loading