From 13a6213d651e151bfef5906942bb7264777ba0eb Mon Sep 17 00:00:00 2001 From: David Bruant Date: Tue, 7 Apr 2020 16:07:56 +0200 Subject: [PATCH 1/7] Add glossary to menu + add handle definition --- main/.vuepress/themeConfig/nav.js | 5 +++++ main/{ertp => }/glossary/README.md | 5 +++++ 2 files changed, 10 insertions(+) rename main/{ertp => }/glossary/README.md (88%) diff --git a/main/.vuepress/themeConfig/nav.js b/main/.vuepress/themeConfig/nav.js index 9955526dd..410655b38 100644 --- a/main/.vuepress/themeConfig/nav.js +++ b/main/.vuepress/themeConfig/nav.js @@ -71,6 +71,11 @@ module.exports = [ ariaLabel: 'Dapps', link: '/dapps/', }, + { + text: 'Glossary', + ariaLabel: 'Glossary Menu', + link: '/glossary/' + }, { text: 'Learn More', ariaLabel: 'Learn More Menu', diff --git a/main/ertp/glossary/README.md b/main/glossary/README.md similarity index 88% rename from main/ertp/glossary/README.md rename to main/glossary/README.md index 1274252c2..ce6149f08 100644 --- a/main/ertp/glossary/README.md +++ b/main/glossary/README.md @@ -1,5 +1,7 @@ # ERTP Glossary +This page lists words, expressions or concepts that are used by the Agoric technology stack + ## AllegedName Human-readable name of a kind of rights. The alleged name should not be trusted as an accurate depiction, since it is provided by @@ -39,6 +41,9 @@ Extents describe the extent of something that can be owned or shared: How much, Extent must be Comparable. +## Handle +A handle is a unique identifier implemented as an JavaScript object. Only its identity is meaningful, so most handles do not properties. For instance, there exists an `offerHandle` is Zoe contracts. The `offerHandle` is the key to knowing what the current allocation for this offer is or to reallocate assets to this offerHandle. + ## Issuer Can create empty purses and payments, but it cannot mint new amounts. The issuer can also transform payments (splitting payments, combining payments, burning payments, and claiming payments exclusively). The issuer should be gotten from a trusted source and then relied upon as the decider of whether an untrusted payment is valid. From 15967b3b9b522539fe359ffb25387386519be09f Mon Sep 17 00:00:00 2001 From: David Bruant Date: Tue, 7 Apr 2020 16:09:58 +0200 Subject: [PATCH 2/7] improve definition of handle --- main/glossary/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/main/glossary/README.md b/main/glossary/README.md index ce6149f08..297917e77 100644 --- a/main/glossary/README.md +++ b/main/glossary/README.md @@ -42,7 +42,9 @@ Extents describe the extent of something that can be owned or shared: How much, Extent must be Comparable. ## Handle -A handle is a unique identifier implemented as an JavaScript object. Only its identity is meaningful, so most handles do not properties. For instance, there exists an `offerHandle` is Zoe contracts. The `offerHandle` is the key to knowing what the current allocation for this offer is or to reallocate assets to this offerHandle. +A handle is a unique identifier implemented as an JavaScript object. Only its identity is meaningful, so most handles do not properties. Unlike number or string identifiers, handles are unforgeable. This means no one who doesn't already have reference to the handle can create a fake a new reference to it. + +For example, there exists an `offerHandle` is Zoe contracts. The `offerHandle` is the key to knowing what the current allocation for this offer is or to reallocate assets to this offerHandle. ## Issuer Can create empty purses and payments, but it cannot mint new amounts. The issuer can also transform payments (splitting payments, combining payments, burning payments, and claiming payments exclusively). The issuer should be gotten from a trusted source and then relied upon as the decider of whether an untrusted payment is valid. From 378c197ebf3ce9647b77ce44397079f8d4b64ba3 Mon Sep 17 00:00:00 2001 From: David Bruant Date: Tue, 7 Apr 2020 18:30:06 +0200 Subject: [PATCH 3/7] Update main/glossary/README.md Co-Authored-By: Chris Hibbert --- main/glossary/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/main/glossary/README.md b/main/glossary/README.md index 297917e77..e2fddb3c0 100644 --- a/main/glossary/README.md +++ b/main/glossary/README.md @@ -42,7 +42,7 @@ Extents describe the extent of something that can be owned or shared: How much, Extent must be Comparable. ## Handle -A handle is a unique identifier implemented as an JavaScript object. Only its identity is meaningful, so most handles do not properties. Unlike number or string identifiers, handles are unforgeable. This means no one who doesn't already have reference to the handle can create a fake a new reference to it. +A handle is a unique identifier implemented as a JavaScript object. Only its identity is meaningful, so most handles do not have properties. Unlike number or string identifiers, handles are unforgeable. This means no one who doesn't already have reference to the handle can create a fake a new reference to it. For example, there exists an `offerHandle` is Zoe contracts. The `offerHandle` is the key to knowing what the current allocation for this offer is or to reallocate assets to this offerHandle. From 7be7cbfd2af4ece7697e5338f4c814f8a5e1595f Mon Sep 17 00:00:00 2001 From: David Bruant Date: Tue, 7 Apr 2020 18:30:13 +0200 Subject: [PATCH 4/7] Update main/glossary/README.md Co-Authored-By: Chris Hibbert --- main/glossary/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/main/glossary/README.md b/main/glossary/README.md index e2fddb3c0..f68169c47 100644 --- a/main/glossary/README.md +++ b/main/glossary/README.md @@ -44,7 +44,7 @@ Extent must be Comparable. ## Handle A handle is a unique identifier implemented as a JavaScript object. Only its identity is meaningful, so most handles do not have properties. Unlike number or string identifiers, handles are unforgeable. This means no one who doesn't already have reference to the handle can create a fake a new reference to it. -For example, there exists an `offerHandle` is Zoe contracts. The `offerHandle` is the key to knowing what the current allocation for this offer is or to reallocate assets to this offerHandle. +For example, Zoe contracts have an `offerHandle`. The `offerHandle` is the key for requesting the current allocation for this offer or reallocating the offerHandle's assets. ## Issuer Can create empty purses and payments, but it cannot mint new amounts. The issuer can also transform payments (splitting payments, combining payments, burning payments, and claiming payments exclusively). The issuer should be gotten from a trusted source and then relied upon as the decider of whether an untrusted payment is valid. From d3e96382640b5645b85b85ab5c447101b41d2756 Mon Sep 17 00:00:00 2001 From: David Bruant Date: Thu, 9 Apr 2020 17:35:15 +0200 Subject: [PATCH 5/7] Update main/glossary/README.md Co-Authored-By: Kate Sills --- main/glossary/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/main/glossary/README.md b/main/glossary/README.md index f68169c47..40fd669b0 100644 --- a/main/glossary/README.md +++ b/main/glossary/README.md @@ -42,7 +42,7 @@ Extents describe the extent of something that can be owned or shared: How much, Extent must be Comparable. ## Handle -A handle is a unique identifier implemented as a JavaScript object. Only its identity is meaningful, so most handles do not have properties. Unlike number or string identifiers, handles are unforgeable. This means no one who doesn't already have reference to the handle can create a fake a new reference to it. +A handle is a unique identifier implemented as a JavaScript object. Only its identity is meaningful, so handles do not have properties. Unlike number or string identifiers, handles are unforgeable. This means the only way to know a handle identity is being given an object reference, and no identity can be guessed and no fake identity will succeed. For example, Zoe contracts have an `offerHandle`. The `offerHandle` is the key for requesting the current allocation for this offer or reallocating the offerHandle's assets. From 188f5bb81b3048a446a3f1f2d49954ed76408355 Mon Sep 17 00:00:00 2001 From: David Bruant Date: Thu, 9 Apr 2020 17:39:50 +0200 Subject: [PATCH 6/7] Update main/glossary/README.md Co-Authored-By: Kate Sills --- main/glossary/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/main/glossary/README.md b/main/glossary/README.md index 40fd669b0..7adcfe922 100644 --- a/main/glossary/README.md +++ b/main/glossary/README.md @@ -44,7 +44,7 @@ Extent must be Comparable. ## Handle A handle is a unique identifier implemented as a JavaScript object. Only its identity is meaningful, so handles do not have properties. Unlike number or string identifiers, handles are unforgeable. This means the only way to know a handle identity is being given an object reference, and no identity can be guessed and no fake identity will succeed. -For example, Zoe contracts have an `offerHandle`. The `offerHandle` is the key for requesting the current allocation for this offer or reallocating the offerHandle's assets. +For example, Zoe often uses `offerHandle` to refer to offers. Zoe contracts can use an offer's `offerHandle` as the key for requesting the current allocation of an offer or reallocating the offer's assets. ## Issuer Can create empty purses and payments, but it cannot mint new amounts. The issuer can also transform payments (splitting payments, combining payments, burning payments, and claiming payments exclusively). The issuer should be gotten from a trusted source and then relied upon as the decider of whether an untrusted payment is valid. From 0e28af6b6573bf28274e8304d2438fe4fd0420e8 Mon Sep 17 00:00:00 2001 From: David Bruant Date: Thu, 9 Apr 2020 17:40:33 +0200 Subject: [PATCH 7/7] Address review comments --- main/glossary/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/main/glossary/README.md b/main/glossary/README.md index 7adcfe922..2f95cda6f 100644 --- a/main/glossary/README.md +++ b/main/glossary/README.md @@ -1,6 +1,6 @@ -# ERTP Glossary +# Glossary -This page lists words, expressions or concepts that are used by the Agoric technology stack +This page lists words, expressions, or concepts used by the Agoric technology stack. ## AllegedName Human-readable name of a kind of rights. The alleged name should @@ -47,7 +47,7 @@ A handle is a unique identifier implemented as a JavaScript object. Only its ide For example, Zoe often uses `offerHandle` to refer to offers. Zoe contracts can use an offer's `offerHandle` as the key for requesting the current allocation of an offer or reallocating the offer's assets. ## Issuer -Can create empty purses and payments, but it cannot mint new amounts. The issuer can also transform payments (splitting payments, combining payments, burning payments, and claiming payments exclusively). The issuer should be gotten from a trusted source and then relied upon as the decider of whether an untrusted payment is valid. +Can create empty purses and payments, but cannot mint new amounts. Issuers can also transform payments (splitting, combining, burning, and claiming payments exclusively). You should get an issuer from a trusted source and then rely on it to determine if an untrusted payment is valid. Issuers are linked to a single mint and vice versa, so each issuer only works with one type of thing, such as only working with quatloos or only working with moola. ## MathHelpers Arithmetic on extents. MathHelpers are used by AmountMath to do their extent arithmetic, and then brand the result, making a new amount.