Skip to content

Commit

Permalink
Implement requested changes (wording, vale, grammarly, some interlink…
Browse files Browse the repository at this point in the history 
…ing)
  • Loading branch information
@louis-md
louis-md committed Dec 6, 2023
1 parent b999977 commit 52df0f7
Showing 1 changed file with 29 additions and 31 deletions.
60 changes: 29 additions & 31 deletions miscellaneous/glossary.md
View file
Original file line number Diff line number Diff line change
@@ -1,40 +1,36 @@
# Glossary

This glossary is a collection of terms and definitions used throughout the Safe{Core} documentation.
This glossary contains terms and definitions used throughout the Safe{Core} documentation.

## A

### Account

An account is a user's Ethereum account. It is represented by an Ethereum address and is used to sign transactions and messages. It can also be found as a EOA (Externally Owned Account). The main vision of the Safe{Core} is to provide a safe and secure way to improve Ethereum accounts, that we refer to as [Smart Accounts](#smart-accounts).
An account is a user's Ethereum account. It represents an Ethereum address and is used to sign transactions and messages. EOA (Externally Owned Account). The central vision of the Safe{Core} is to provide a safe and secure way to improve Ethereum accounts, which we call [Smart Accounts](#smart-accounts).

### Account Abstraction

Account abstraction is a term used to describe the process of abstracting the concept of an account. It is a way to improve the security of Ethereum accounts by adding a layer of abstraction on top of them, adding features for [recoverability](#recoverability), [social logins](#social-login) and [gasless transactions](#gasless-transactions). This layer of abstraction is the main concept we use to build Safe's vision for modular [Smart Accounts](#smart-accounts).
Account abstraction is a term used to describe the process of abstracting the concept of an account. It is a way to improve the security of Ethereum accounts by adding a layer of abstraction on top of them, adding features for [recoverability](#recoverability), [social logins](#social-login), and [gasless transactions](#gasless-transactions)](#gasless-transactions). This abstraction layer is our central concept to build Safe's vision for modular [Smart Accounts](#smart-accounts).

Check failure on line 13 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L13 

[Microsoft.Contractions] Use 'it's' instead of 'It is'.
Raw output 
{"message": "[Microsoft.Contractions] Use 'it's' instead of 'It is'.", "location": {"path": "miscellaneous/glossary.md", "range": {"start": {"line": 13, "column": 102}}}, "severity": "ERROR"}

Check failure on line 13 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L13 

[Vale.Spelling] Did you really mean 'gasless'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'gasless'?", "location": {"path": "miscellaneous/glossary.md", "range": {"start": {"line": 13, "column": 300}}}, "severity": "ERROR"}

### Apps

Safe Apps are web applications that can be used to interact with Safe. They are used to provide a better user experience when interacting with Safe, and are mostly built using the [Safe Apps SDK](../safe-apps/README.md). They can be used to interact with Safe's core features, such as [transactions](#transactions) and [modules](#modules), or to provide entirely new features. They are gathered in the a [Safe App Gallery](https://app.safe.global/apps) and can be used by any Safe{Wallet} user.
Safe Apps are web applications that can interact with Safe. They are used to provide a better user experience when interacting with Safe and internally use the [Safe Apps SDK](../safe-apps/README.md). They can interact with Safe{Wallet} and fully utilize its main features, such as [transactions](#transactions) and [modules](#modules). The [Safe App Gallery](https://app.safe.global/apps) displays all the Apps that any Safe{Wallet} user can use.

Check failure on line 17 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L17 

[Microsoft.Contractions] Use 'they're' instead of 'They are'.
Raw output 
{"message": "[Microsoft.Contractions] Use 'they're' instead of 'They are'.", "location": {"path": "miscellaneous/glossary.md", "range": {"start": {"line": 17, "column": 61}}}, "severity": "ERROR"}

### AuthKit

AuthKit is a part of the Safe{Core} SDK that provides a set of tools to authenticate users and sign messages. It is used to sign transactions and messages with the user's Ethereum account. It also provides a set of tools to authenticate users with more familiar web services, such as Gmail. In this last case, we talk about [Social Login](#social-login).
The AuthKit is a library of the Safe{Core} SDK that provides a set of tools to authenticate users with one of the different [Social Login](#social-login) methods offered, generating an externally owned account that can act as the signer of a Safe.

## G

### Gasless Transactions

Check failure on line 25 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L25 

[Vale.Spelling] Did you really mean 'Gasless'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'Gasless'?", "location": {"path": "miscellaneous/glossary.md", "range": {"start": {"line": 25, "column": 5}}}, "severity": "ERROR"}

Gasless transactions are [Ethereum transactions](#transactions) that are paid for by a third-party. They can either be paid for by a [relayer](#relayers), or by a Safe{Wallet} user's Safe. They are used to provide a better user experience by removing the need for users to pay for gas fees, or even having to buy cryptocurrency altogether when interacting with a blockchain.
Gasless transactions are [Ethereum transactions](#transactions) that are paid for by a third party. They can be paid for by a [relayer](#relayers) or a Safe{Wallet} user's Safe. They are used to provide a better user experience by removing the need for users to pay for gas fees or even having to buy cryptocurrency altogether when interacting with a blockchain.

Check failure on line 27 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L27 

[Vale.Spelling] Did you really mean 'Gasless'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'Gasless'?", "location": {"path": "miscellaneous/glossary.md", "range": {"start": {"line": 27, "column": 1}}}, "severity": "ERROR"}

Check failure on line 27 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L27 

[Vale.Spelling] Did you really mean 'relayer'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'relayer'?", "location": {"path": "miscellaneous/glossary.md", "range": {"start": {"line": 27, "column": 128}}}, "severity": "ERROR"}

Check failure on line 27 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L27 

[Microsoft.Contractions] Use 'they're' instead of 'They are'.
Raw output 
{"message": "[Microsoft.Contractions] Use 'they're' instead of 'They are'.", "location": {"path": "miscellaneous/glossary.md", "range": {"start": {"line": 27, "column": 179}}}, "severity": "ERROR"}

### Guards
## N

Guards are smart contracts that are used to protect Safe transactions. They are used to add an extra layer of security to Safe transactions by adding custom rules to them before and/or after a transaction. For example, a guard can be used to protect a Safe transaction from being executed if the transaction is not signed by a specific user.
### Networks

## M

### Modules

Safe Modules add custom features to Safe contracts. They are smart contracts that add functionality to Safe while separating module logic from Safe's core contracts, such as support for [gasless transactions](#gasless-transactions) or [allowances](https://github.com/safe-global/safe-modules/tree/master/allowances).
Networks are Ethereum-based ledgers. They are used to store transactions and smart contracts. They are also used to transfer funds from one account to another or as a support to interact with smart contracts.

Check failure on line 33 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L33 

[Microsoft.Contractions] Use 'they're' instead of 'They are'.
Raw output 
{"message": "[Microsoft.Contractions] Use 'they're' instead of 'They are'.", "location": {"path": "miscellaneous/glossary.md", "range": {"start": {"line": 33, "column": 38}}}, "severity": "ERROR"}

Check failure on line 33 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L33 

[Microsoft.Contractions] Use 'they're' instead of 'They are'.
Raw output 
{"message": "[Microsoft.Contractions] Use 'they're' instead of 'They are'.", "location": {"path": "miscellaneous/glossary.md", "range": {"start": {"line": 33, "column": 95}}}, "severity": "ERROR"}

## P

Expand All @@ -44,46 +40,48 @@ Plugins are a way to extend the functionality of Safe{Core} by adding custom fea

## R

### Recoverability

Recoverability is a term used to describe the process of recovering access to a Safe. It is a way to improve the security of Safes by enabling Safe owners to split control of their Safe with a decentralized committee selected by Safe{DAO}.

### Relayers

Check failure on line 43 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L43 

[Vale.Spelling] Did you really mean 'Relayers'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'Relayers'?", "location": {"path": "miscellaneous/glossary.md", "range": {"start": {"line": 43, "column": 5}}}, "severity": "ERROR"}

Relayers are third-party services that can be used to pay for gas fees on behalf of users. They are used to provide [gasless transactions](#gasless-transactions) to Safe users.
Relayers are third-party services that can pay for gas fees on behalf of users. They are used to provide [gasless transactions](#gasless-transactions) to Safe users.

Check failure on line 45 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L45 

[Vale.Spelling] Did you really mean 'Relayers'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'Relayers'?", "location": {"path": "miscellaneous/glossary.md", "range": {"start": {"line": 45, "column": 1}}}, "severity": "ERROR"}

Check failure on line 45 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L45 

[Microsoft.Contractions] Use 'they're' instead of 'They are'.
Raw output 
{"message": "[Microsoft.Contractions] Use 'they're' instead of 'They are'.", "location": {"path": "miscellaneous/glossary.md", "range": {"start": {"line": 45, "column": 81}}}, "severity": "ERROR"}

Check failure on line 45 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L45 

[Vale.Spelling] Did you really mean 'gasless'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'gasless'?", "location": {"path": "miscellaneous/glossary.md", "range": {"start": {"line": 45, "column": 107}}}, "severity": "ERROR"}

## S

### Safe

A Safe is a smart contract that is used to store funds and execute transactions on behalf of its owners. It is represented by an Ethereum address and is supercharged with features making it as easy as possible to use. It is the main output from Safe's vision for modular [Smart Accounts](#smart-accounts).
A Safe is a smart contract used to store funds and execute transactions on behalf of its owners. It has an Ethereum address and is supercharged with features, making it as easy as possible. It is the main output from Safe's vision for modular [Smart Accounts](#smart-accounts).

Check failure on line 51 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L51 

[Microsoft.Contractions] Use 'it's' instead of 'It is'.
Raw output 
{"message": "[Microsoft.Contractions] Use 'it's' instead of 'It is'.", "location": {"path": "miscellaneous/glossary.md", "range": {"start": {"line": 51, "column": 191}}}, "severity": "ERROR"}

### Safe{Core}

Safe{Core} is a set of smart contracts and Typescript packages that are used to build Safe{Wallet}.
Safe{Core} is a set of smart contracts and Typescript packages used to build Safe{Wallet}.

### Safe{Wallet}

Safe{Wallet} is a web and mobile wallet UI that is used to manage Safes. It is used to sign transactions and messages, and to interact with other smart contracts from the web, at [app.safe.global](https://app.safe.global), or from a mobile device, using the [Safe{Wallet} mobile app](https://safe.global/wallet). It is built entirely using the [Safe{Core} SDK](../safe-core-sdk/README.md).
Safe{Wallet} is a web and mobile wallet UI that manages Safes. It can sign transactions and messages and interact with other smart contracts from the web, at [app.safe.global](https://app.safe.global), or from a mobile device, using the [Safe{Wallet} mobile app](https://safe.global/wallet). It uses the Safe{Core} SDK internally.

### Safe{RecoveryHub}

Safe{RecoveryHub} is a process used to describe recovering access to a Safe. It is a way to improve the security of Safes by enabling Safe owners to split control of their Safe with a decentralized committee selected by Safe{DAO}. You can know more by reading the [Safe Recovery](https://help.safe.global/en/articles/110656-account-recovery-with-safe-recoveryhub) guide.

Check failure on line 63 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L63 

[Microsoft.Contractions] Use 'it's' instead of 'It is'.
Raw output 
{"message": "[Microsoft.Contractions] Use 'it's' instead of 'It is'.", "location": {"path": "miscellaneous/glossary.md", "range": {"start": {"line": 63, "column": 78}}}, "severity": "ERROR"}

### Safe Guards

Guards are smart contracts that can protect Safe transactions. They are used to add an extra layer of security to Safe transactions by adding custom rules to them before or after a transaction. For example, a guard can protect a Safe transaction from being executed if a specific user does not sign the transaction.

Check failure on line 67 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L67 

[Microsoft.Contractions] Use 'they're' instead of 'They are'.
Raw output 
{"message": "[Microsoft.Contractions] Use 'they're' instead of 'They are'.", "location": {"path": "miscellaneous/glossary.md", "range": {"start": {"line": 67, "column": 64}}}, "severity": "ERROR"}

Check failure on line 67 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L67 

[Microsoft.Contractions] Use 'doesn't' instead of 'does not'.
Raw output 
{"message": "[Microsoft.Contractions] Use 'doesn't' instead of 'does not'.", "location": {"path": "miscellaneous/glossary.md", "range": {"start": {"line": 67, "column": 286}}}, "severity": "ERROR"}

### Safe Modules

Safe Modules add custom features to Safe contracts. Smart contracts add functionality to Safe while separating module logic from Safe's core contracts, such as support for [gasless transactions](#gasless-transactions) or [allowances](https://github.com/safe-global/safe-modules/tree/master/allowances).

Check failure on line 71 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L71 

[Vale.Spelling] Did you really mean 'gasless'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'gasless'?", "location": {"path": "miscellaneous/glossary.md", "range": {"start": {"line": 71, "column": 174}}}, "severity": "ERROR"}

## T

### Transactions
### Transactions‡

Transactions are what change the state of Ethereum-based ledgers. They are used to transfer funds from one account to another, or to interact with smart contracts.
Transactions are what change the state of Ethereum-based ledgers. They are used to transfer funds from one account to another or to interact with smart contracts. You can learn more about how Safe{Wallet} handles transactions by reading the [Transactions](https://help.safe.global/en/collections/9814-transactions) section of our [Support Center](help.safe.global).

Check failure on line 77 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L77 

[Microsoft.Contractions] Use 'they're' instead of 'They are'.
Raw output 
{"message": "[Microsoft.Contractions] Use 'they're' instead of 'They are'.", "location": {"path": "miscellaneous/glossary.md", "range": {"start": {"line": 77, "column": 67}}}, "severity": "ERROR"}

## W

### Wallet

A wallet is a software that is used to manage Ethereum accounts. It is used to sign transactions and messages, and to interact with smart contracts.
A wallet is a piece of software used to manage Ethereum accounts. It can sign transactions and messages and interact with smart contracts.

### WalletConnect

WalletConnect is a protocol for connecting decentralized applications to mobile wallets with QR code scanning or deep linking.

## Z

### Zero-Knowledge Proofs

ZKPs (Zero-Knowledge Proofs) are cryptographic proofs that can be used to prove the validity of a statement without revealing any information about it.
WalletConnect is a protocol for connecting decentralized applications to mobile wallets with QR code scanning or deep linking. It can be used to connect Safe{Wallet} to other decentralized applications. You can follow [this guide](https://help.safe.global/en/articles/108235-how-to-connect-a-safe-to-a-dapp-using-walletconnect) to know more.

0 comments on commit 52df0f7

Please sign in to comment.