Skip to content

Commit

Permalink
Add glossary page
Browse files Browse the repository at this point in the history
  • Loading branch information
louis-md committed Nov 24, 2023
1 parent ee0962d commit 72c6f9b
Show file tree
Hide file tree
Showing 2 changed files with 90 additions and 0 deletions.
1 change: 1 addition & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@

## Miscellaneous

* [Glossary](miscellaneous/glossary.md)
* [Bug Bounty](miscellaneous/bug-bounty-program.md)
* [Past paid bounties](miscellaneous/past-paid-bounties.md)
* [Contact us](miscellaneous/contact-us.md)
89 changes: 89 additions & 0 deletions miscellaneous/glossary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# Glossary

This glossary is a collection of 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).

Check failure on line 9 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L9

[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": 9, "column": 42}}}, "severity": "ERROR"}

### 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).

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": 299}}}, "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.

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": 72}}}, "severity": "ERROR"}

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": 378}}}, "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).

Check failure on line 21 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L21

[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": 21, "column": 111}}}, "severity": "ERROR"}

## 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.

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": 135}}}, "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": 190}}}, "severity": "ERROR"}

### Guards

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.

Check failure on line 31 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L31

[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": 31, "column": 72}}}, "severity": "ERROR"}

Check failure on line 31 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L31

[Microsoft.Contractions] Use 'isn't' instead of 'is not'.
Raw output
{"message": "[Microsoft.Contractions] Use 'isn't' instead of 'is not'.", "location": {"path": "miscellaneous/glossary.md", "range": {"start": {"line": 31, "column": 309}}}, "severity": "ERROR"}

## 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).

Check failure on line 37 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L37

[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": 37, "column": 53}}}, "severity": "ERROR"}

Check failure on line 37 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L37

[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": 37, "column": 188}}}, "severity": "ERROR"}

## P

### Plugins

Plugins are a way to extend the functionality of Safe{Core} by adding custom features to it. They are used to add support for new [modules](#modules) or [guards](#guards) to a Safe.

Check failure on line 43 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L43

[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": 43, "column": 94}}}, "severity": "ERROR"}

## 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}.

Check failure on line 49 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L49

[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": 49, "column": 87}}}, "severity": "ERROR"}

### Relayers

Check failure on line 51 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L51

[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": 51, "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.

Check failure on line 53 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L53

[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": 53, "column": 1}}}, "severity": "ERROR"}

Check failure on line 53 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L53

[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": 53, "column": 92}}}, "severity": "ERROR"}

Check failure on line 53 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L53

[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": 53, "column": 118}}}, "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).

Check failure on line 59 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L59

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

Check failure on line 59 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L59

[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": 59, "column": 106}}}, "severity": "ERROR"}

Check failure on line 59 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L59

[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": 59, "column": 219}}}, "severity": "ERROR"}

### Safe{Core}

Safe{Core} is a set of smart contracts and Typescript packages that are 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/download). It is built entirely using the [Safe{Core} SDK](../safe-core-sdk/README.md).

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 'that's' instead of 'that is'.
Raw output
{"message": "[Microsoft.Contractions] Use 'that's' instead of 'that is'.", "location": {"path": "miscellaneous/glossary.md", "range": {"start": {"line": 67, "column": 44}}}, "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 '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": 67, "column": 74}}}, "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 '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": 67, "column": 316}}}, "severity": "ERROR"}

## T

### 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.

Check failure on line 73 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L73

[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": 73, "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.

Check failure on line 79 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L79

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

Check failure on line 79 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L79

[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": 79, "column": 66}}}, "severity": "ERROR"}

### 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.

Check failure on line 89 in miscellaneous/glossary.md

View workflow job for this annotation

GitHub Actions / vale

[vale] miscellaneous/glossary.md#L89

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

0 comments on commit 72c6f9b

Please sign in to comment.