@agoric/ertp 0.16.3-dev-7cc5def.0 → 0.16.3-u11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +743 -0
- package/package.json +17 -17
- package/src/amountMath.d.ts +13 -14
- package/src/amountMath.d.ts.map +1 -1
- package/src/amountMath.js +63 -57
- package/src/issuerKit.d.ts +3 -3
- package/src/issuerKit.d.ts.map +1 -1
- package/src/issuerKit.js +57 -51
- package/src/legacy-payment-helpers.d.ts.map +1 -1
- package/src/legacy-payment-helpers.js +28 -23
- package/src/mathHelpers/copyBagMathHelpers.d.ts +3 -1
- package/src/mathHelpers/copyBagMathHelpers.d.ts.map +1 -1
- package/src/mathHelpers/copyBagMathHelpers.js +3 -1
- package/src/mathHelpers/copySetMathHelpers.d.ts +3 -1
- package/src/mathHelpers/copySetMathHelpers.d.ts.map +1 -1
- package/src/mathHelpers/copySetMathHelpers.js +3 -1
- package/src/mathHelpers/natMathHelpers.d.ts +7 -6
- package/src/mathHelpers/natMathHelpers.d.ts.map +1 -1
- package/src/mathHelpers/natMathHelpers.js +7 -6
- package/src/payment.d.ts +1 -1
- package/src/payment.d.ts.map +1 -1
- package/src/paymentLedger.d.ts +1 -1
- package/src/paymentLedger.d.ts.map +1 -1
- package/src/paymentLedger.js +40 -36
- package/src/typeGuards.d.ts +6 -36
- package/src/typeGuards.d.ts.map +1 -1
- package/src/typeGuards.js +41 -35
- package/src/types-ambient.d.ts +174 -177
- package/src/types-ambient.d.ts.map +1 -1
- package/src/types-ambient.js +280 -212
- package/src/types.d.ts +174 -177
- package/src/types.d.ts.map +1 -1
- package/src/types.js +280 -212
package/src/types.d.ts
CHANGED
|
@@ -1,86 +1,86 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Amounts are descriptions of digital assets,
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
2
|
+
* Amounts are descriptions of digital assets, answering the questions
|
|
3
|
+
* "how much" and "of what kind". Amounts are values labeled with a brand.
|
|
4
|
+
* AmountMath executes the logic of how amounts are changed when digital
|
|
5
|
+
* assets are merged, separated, or otherwise manipulated. For
|
|
6
|
+
* example, a deposit of 2 bucks into a purse that already has 3 bucks
|
|
7
|
+
* gives a new purse balance of 5 bucks. An empty purse has 0 bucks. AmountMath
|
|
8
|
+
* relies heavily on polymorphic MathHelpers, which manipulate the unbranded
|
|
9
|
+
* portion.
|
|
10
10
|
*/
|
|
11
11
|
export type Amount<K extends AssetKind = AssetKind> = {
|
|
12
12
|
brand: Brand<K>;
|
|
13
13
|
value: AssetValueForKind<K>;
|
|
14
14
|
};
|
|
15
15
|
/**
|
|
16
|
-
* An
|
|
17
|
-
*
|
|
18
|
-
* shared.
|
|
16
|
+
* An `AmountValue` describes a set or quantity of assets that can be owned or
|
|
17
|
+
* shared.
|
|
19
18
|
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
19
|
+
* A fungible `AmountValue` uses a non-negative bigint to represent a quantity
|
|
20
|
+
* of that many assets.
|
|
22
21
|
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
22
|
+
* A non-fungible `AmountValue` uses an array or CopySet of `Key`s to represent
|
|
23
|
+
* a set of whatever asset each key represents. A `Key` is a passable value
|
|
24
|
+
* that can be used as an element in a set (SetStore or CopySet) or as the
|
|
25
|
+
* key in a map (MapStore or CopyMap).
|
|
27
26
|
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
27
|
+
* `SetValue` is for the deprecated set representation, using an array directly
|
|
28
|
+
* to represent the array of its elements. `CopySet` is the proper
|
|
29
|
+
* representation using a CopySet.
|
|
31
30
|
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
31
|
+
* A semi-fungible `CopyBag` is represented as a
|
|
32
|
+
* `CopyBag` of `Key` objects. "Bag" is synonymous with MultiSet, where an
|
|
33
|
+
* element of a bag can be present once or more times, i.e., some positive
|
|
34
|
+
* bigint number of times, representing that quantity of the asset represented
|
|
35
|
+
* by that key.
|
|
36
36
|
*/
|
|
37
37
|
export type AmountValue = NatValue | any[] | CopySet | CopyBag;
|
|
38
38
|
/**
|
|
39
|
-
* See doc-comment
|
|
40
|
-
* for `AmountValue`.
|
|
39
|
+
* See doc-comment for `AmountValue`.
|
|
41
40
|
*/
|
|
42
41
|
export type AssetKind = 'nat' | 'set' | 'copySet' | 'copyBag';
|
|
43
42
|
export type AssetValueForKind<K extends AssetKind> = K extends 'nat' ? NatValue : K extends 'set' ? any[] : K extends 'copySet' ? CopySet : K extends 'copyBag' ? CopyBag : never;
|
|
44
43
|
export type AssetKindForValue<V extends AmountValue> = V extends NatValue ? 'nat' : V extends any[] ? 'set' : V extends CopySet ? 'copySet' : V extends CopyBag ? 'copyBag' : never;
|
|
45
44
|
export type DisplayInfo<K extends AssetKind = AssetKind> = {
|
|
46
45
|
/**
|
|
47
|
-
* Tells the display software how
|
|
48
|
-
* decimal places to move the decimal over to the left, or in
|
|
49
|
-
* which position corresponds to whole numbers. We
|
|
50
|
-
* assets to be represented in integers, in
|
|
51
|
-
* be represented in mill, a
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
46
|
+
* Tells the display software how
|
|
47
|
+
* many decimal places to move the decimal over to the left, or in
|
|
48
|
+
* other words, which position corresponds to whole numbers. We
|
|
49
|
+
* require fungible digital assets to be represented in integers, in
|
|
50
|
+
* the smallest unit (i.e. USD might be represented in mill, a
|
|
51
|
+
* thousandth of a dollar. In that case, `decimalPlaces` would be
|
|
52
|
+
* 3.) This property is optional, and for non-fungible digital
|
|
53
|
+
* assets, should not be specified. The decimalPlaces property
|
|
54
|
+
* should be used for *display purposes only*. Any other use is an
|
|
55
55
|
* anti-pattern.
|
|
56
56
|
*/
|
|
57
57
|
decimalPlaces?: number | undefined;
|
|
58
58
|
/**
|
|
59
|
-
* - the kind of asset, either
|
|
60
|
-
*
|
|
59
|
+
* - the kind of asset, either
|
|
60
|
+
* AssetKind.NAT (fungible) or
|
|
61
|
+
* AssetKind.SET or AssetKind.COPY_SET (non-fungible)
|
|
61
62
|
*/
|
|
62
63
|
assetKind: K;
|
|
63
64
|
};
|
|
64
65
|
/**
|
|
65
|
-
* The brand identifies the kind of issuer, and has a
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
*
|
|
66
|
+
* The brand identifies the kind of issuer, and has a function to get the
|
|
67
|
+
* alleged name for the kind of asset described. The alleged name (such
|
|
68
|
+
* as 'BTC' or 'moola') is provided by the maker of the issuer and should
|
|
69
|
+
* not be trusted as accurate.
|
|
69
70
|
*
|
|
70
|
-
*
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
*
|
|
71
|
+
* Every amount created by a particular AmountMath will share the same brand,
|
|
72
|
+
* but recipients cannot rely on the brand to verify that a purported amount
|
|
73
|
+
* represents the issuer they intended, since the same brand can be reused by
|
|
74
|
+
* a misbehaving issuer.
|
|
74
75
|
*/
|
|
75
76
|
export type Brand<K extends AssetKind = AssetKind> = {
|
|
76
77
|
/**
|
|
77
|
-
*
|
|
78
|
+
* Should be used with `issuer.getBrand` to ensure an issuer and brand match.
|
|
78
79
|
*/
|
|
79
80
|
isMyIssuer: (allegedIssuer: ERef<Issuer>) => Promise<boolean>;
|
|
80
81
|
getAllegedName: () => string;
|
|
81
82
|
/**
|
|
82
|
-
* Give information to UI on how
|
|
83
|
-
* to display the amount.
|
|
83
|
+
* Give information to UI on how to display the amount.
|
|
84
84
|
*/
|
|
85
85
|
getDisplayInfo: () => DisplayInfo<K>;
|
|
86
86
|
getAmountShape: () => Pattern;
|
|
@@ -88,91 +88,100 @@ export type Brand<K extends AssetKind = AssetKind> = {
|
|
|
88
88
|
/**
|
|
89
89
|
* Return true if the payment continues to exist.
|
|
90
90
|
*
|
|
91
|
-
*
|
|
91
|
+
* If the payment is a promise, the operation will proceed upon
|
|
92
|
+
* resolution.
|
|
92
93
|
*/
|
|
93
94
|
export type IssuerIsLive = (payment: ERef<Payment>) => Promise<boolean>;
|
|
94
95
|
/**
|
|
95
|
-
* Get the amount of digital assets in the payment.
|
|
96
|
-
*
|
|
97
|
-
*
|
|
96
|
+
* Get the amount of digital assets in the payment. Because the
|
|
97
|
+
* payment is not trusted, we cannot call a method on it directly, and
|
|
98
|
+
* must use the issuer instead.
|
|
98
99
|
*
|
|
99
|
-
*
|
|
100
|
+
* If the payment is a promise, the operation will proceed upon
|
|
101
|
+
* resolution.
|
|
100
102
|
*/
|
|
101
103
|
export type IssuerGetAmountOf<K extends AssetKind> = (payment: ERef<Payment>) => Promise<Amount<K>>;
|
|
102
104
|
/**
|
|
103
|
-
* Burn all of the digital assets in the
|
|
104
|
-
*
|
|
105
|
-
*
|
|
106
|
-
*
|
|
105
|
+
* Burn all of the digital assets in the
|
|
106
|
+
* payment. `optAmount` is optional. If `optAmount` is present, the
|
|
107
|
+
* code will insist that the amount of the digital assets in the
|
|
108
|
+
* payment is equal to `optAmount`, to prevent sending the wrong
|
|
109
|
+
* payment and other confusion.
|
|
107
110
|
*
|
|
108
|
-
*
|
|
111
|
+
* If the payment is a promise, the operation will proceed upon
|
|
112
|
+
* resolution.
|
|
109
113
|
*/
|
|
110
114
|
export type IssuerBurn = (payment: ERef<Payment>, optAmountShape?: Pattern) => Promise<Amount>;
|
|
111
115
|
/**
|
|
112
|
-
* Transfer all digital assets from the payment to a new
|
|
113
|
-
*
|
|
114
|
-
*
|
|
115
|
-
*
|
|
116
|
-
*
|
|
116
|
+
* Transfer all digital assets from the payment to a new payment and
|
|
117
|
+
* delete the original. `optAmount` is optional. If `optAmount` is
|
|
118
|
+
* present, the code will insist that the amount of digital assets in
|
|
119
|
+
* the payment is equal to `optAmount`, to prevent sending the wrong
|
|
120
|
+
* payment and other confusion.
|
|
117
121
|
*
|
|
118
|
-
*
|
|
122
|
+
* If the payment is a promise, the operation will proceed upon
|
|
123
|
+
* resolution.
|
|
119
124
|
*/
|
|
120
125
|
export type IssuerClaim<K extends AssetKind> = (payment: ERef<Payment<K>>, optAmountShape?: Pattern) => Promise<Payment<K>>;
|
|
121
126
|
/**
|
|
122
127
|
* Combine multiple payments into one payment.
|
|
123
128
|
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
129
|
+
* If any of the payments is a promise, the operation will proceed
|
|
130
|
+
* upon resolution.
|
|
126
131
|
*/
|
|
127
132
|
export type IssuerCombine<K extends AssetKind> = (paymentsArray: ERef<Payment<K>>[], optTotalAmount?: Amount<K> | undefined) => Promise<Payment<K>>;
|
|
128
133
|
/**
|
|
129
|
-
* Split a single payment into two payments,
|
|
130
|
-
*
|
|
134
|
+
* Split a single payment into two payments,
|
|
135
|
+
* A and B, according to the paymentAmountA passed in.
|
|
131
136
|
*
|
|
132
|
-
*
|
|
137
|
+
* If the payment is a promise, the operation will proceed upon
|
|
138
|
+
* resolution.
|
|
133
139
|
*/
|
|
134
140
|
export type IssuerSplit<K extends AssetKind> = (payment: ERef<Payment<K>>, paymentAmountA: Amount<K>) => Promise<Payment<K>[]>;
|
|
135
141
|
/**
|
|
136
|
-
* Split a single payment into many payments,
|
|
137
|
-
*
|
|
142
|
+
* Split a single payment into many payments, according to the amounts
|
|
143
|
+
* passed in.
|
|
138
144
|
*
|
|
139
|
-
*
|
|
145
|
+
* If the payment is a promise, the operation will proceed upon
|
|
146
|
+
* resolution.
|
|
140
147
|
*/
|
|
141
148
|
export type IssuerSplitMany = (payment: ERef<Payment>, amounts: Amount[]) => Promise<Payment[]>;
|
|
142
149
|
/**
|
|
143
|
-
* The issuer cannot mint a new amount, but it can
|
|
144
|
-
*
|
|
145
|
-
*
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
*
|
|
150
|
+
* The issuer cannot mint a new amount, but it can create empty purses
|
|
151
|
+
* and payments. The issuer can also transform payments (splitting
|
|
152
|
+
* payments, combining payments, burning payments, and claiming
|
|
153
|
+
* payments exclusively). The issuer should be gotten from a trusted
|
|
154
|
+
* source and then relied upon as the decider of whether an untrusted
|
|
155
|
+
* payment is valid.
|
|
149
156
|
*/
|
|
150
157
|
export type Issuer<K extends AssetKind = AssetKind> = {
|
|
151
158
|
/**
|
|
152
|
-
* Get the Brand for this Issuer. The
|
|
153
|
-
* indicates the type of digital asset and is shared by the
|
|
154
|
-
* and any purses and payments of this particular
|
|
155
|
-
* closely held, so this function should not be
|
|
156
|
-
* alone. Fake digital assets and amount
|
|
159
|
+
* Get the Brand for this Issuer. The
|
|
160
|
+
* Brand indicates the type of digital asset and is shared by the
|
|
161
|
+
* mint, the issuer, and any purses and payments of this particular
|
|
162
|
+
* kind. The brand is not closely held, so this function should not be
|
|
163
|
+
* trusted to identify an issuer alone. Fake digital assets and amount
|
|
164
|
+
* can use another issuer's brand.
|
|
157
165
|
*/
|
|
158
166
|
getBrand: () => Brand<K>;
|
|
159
167
|
/**
|
|
160
|
-
* Get the allegedName for
|
|
161
|
-
* mint/issuer
|
|
168
|
+
* Get the allegedName for
|
|
169
|
+
* this mint/issuer
|
|
162
170
|
*/
|
|
163
171
|
getAllegedName: () => string;
|
|
164
172
|
/**
|
|
165
|
-
* Get the kind of
|
|
166
|
-
* this Issuer.
|
|
173
|
+
* Get the kind of
|
|
174
|
+
* MathHelpers used by this Issuer.
|
|
167
175
|
*/
|
|
168
176
|
getAssetKind: () => AssetKind;
|
|
169
177
|
/**
|
|
170
|
-
* Give information to UI
|
|
171
|
-
* to display amounts for this issuer.
|
|
178
|
+
* Give information to UI
|
|
179
|
+
* on how to display amounts for this issuer.
|
|
172
180
|
*/
|
|
173
181
|
getDisplayInfo: () => DisplayInfo<K>;
|
|
174
182
|
/**
|
|
175
|
-
* Make an empty purse of this
|
|
183
|
+
* Make an empty purse of this
|
|
184
|
+
* brand.
|
|
176
185
|
*/
|
|
177
186
|
makeEmptyPurse: () => Purse<K>;
|
|
178
187
|
isLive: IssuerIsLive;
|
|
@@ -194,14 +203,15 @@ export type IssuerKit<K extends AssetKind = AssetKind> = {
|
|
|
194
203
|
};
|
|
195
204
|
export type AdditionalDisplayInfo = {
|
|
196
205
|
/**
|
|
197
|
-
* Tells the display software how
|
|
198
|
-
* decimal places to move the decimal over to the left, or in
|
|
199
|
-
* which position corresponds to whole numbers. We
|
|
200
|
-
* assets to be represented in integers, in
|
|
201
|
-
* be represented in mill, a
|
|
202
|
-
*
|
|
203
|
-
*
|
|
204
|
-
*
|
|
206
|
+
* Tells the display software how
|
|
207
|
+
* many decimal places to move the decimal over to the left, or in
|
|
208
|
+
* other words, which position corresponds to whole numbers. We
|
|
209
|
+
* require fungible digital assets to be represented in integers, in
|
|
210
|
+
* the smallest unit (i.e. USD might be represented in mill, a
|
|
211
|
+
* thousandth of a dollar. In that case, `decimalPlaces` would be
|
|
212
|
+
* 3.) This property is optional, and for non-fungible digital
|
|
213
|
+
* assets, should not be specified. The decimalPlaces property
|
|
214
|
+
* should be used for *display purposes only*. Any other use is an
|
|
205
215
|
* anti-pattern.
|
|
206
216
|
*/
|
|
207
217
|
decimalPlaces?: number | undefined;
|
|
@@ -209,8 +219,8 @@ export type AdditionalDisplayInfo = {
|
|
|
209
219
|
};
|
|
210
220
|
export type ShutdownWithFailure = import('@agoric/swingset-vat').ShutdownWithFailure;
|
|
211
221
|
/**
|
|
212
|
-
* Holding a Mint carries the right to issue new digital
|
|
213
|
-
*
|
|
222
|
+
* Holding a Mint carries the right to issue new digital assets. These
|
|
223
|
+
* assets all have the same kind, which is called a Brand.
|
|
214
224
|
*/
|
|
215
225
|
export type Mint<K extends AssetKind = AssetKind> = {
|
|
216
226
|
/**
|
|
@@ -218,18 +228,16 @@ export type Mint<K extends AssetKind = AssetKind> = {
|
|
|
218
228
|
*/
|
|
219
229
|
getIssuer: () => Issuer<K>;
|
|
220
230
|
/**
|
|
221
|
-
* Creates a new
|
|
222
|
-
* Payment containing newly minted amount.
|
|
231
|
+
* Creates a new Payment containing newly minted amount.
|
|
223
232
|
*/
|
|
224
233
|
mintPayment: (newAmount: Amount<K>) => Payment<K>;
|
|
225
234
|
};
|
|
226
235
|
export type DepositFacetReceive = (payment: Payment, optAmountShape?: Pattern) => Amount;
|
|
227
236
|
export type DepositFacet = {
|
|
228
237
|
/**
|
|
229
|
-
* Deposit all the contents of payment
|
|
230
|
-
*
|
|
231
|
-
*
|
|
232
|
-
* payment, throw an error.
|
|
238
|
+
* Deposit all the contents of payment into the purse that made this facet,
|
|
239
|
+
* returning the amount. If the optional argument `optAmount` does not equal the
|
|
240
|
+
* amount of digital assets in the payment, throw an error.
|
|
233
241
|
*
|
|
234
242
|
* If payment is a promise, throw an error.
|
|
235
243
|
*/
|
|
@@ -237,125 +245,116 @@ export type DepositFacet = {
|
|
|
237
245
|
};
|
|
238
246
|
export type PurseDeposit<K extends AssetKind> = (payment: Payment<K>, optAmountShape?: Pattern) => Amount<K>;
|
|
239
247
|
/**
|
|
240
|
-
* Purses hold amount of digital assets of the same
|
|
241
|
-
*
|
|
242
|
-
*
|
|
243
|
-
*
|
|
244
|
-
* deposit() and withdraw().
|
|
248
|
+
* Purses hold amount of digital assets of the same brand, but unlike Payments,
|
|
249
|
+
* they are not meant to be sent to others. To transfer digital assets, a
|
|
250
|
+
* Payment should be withdrawn from a Purse. The amount of digital
|
|
251
|
+
* assets in a purse can change through the action of deposit() and withdraw().
|
|
245
252
|
*
|
|
246
|
-
*
|
|
247
|
-
*
|
|
248
|
-
*
|
|
253
|
+
* The primary use for Purses and Payments is for currency-like and goods-like
|
|
254
|
+
* digital assets, but they can also be used to represent other kinds of rights,
|
|
255
|
+
* such as the right to participate in a particular contract.
|
|
249
256
|
*/
|
|
250
257
|
export type Purse<K extends AssetKind = AssetKind> = {
|
|
251
258
|
/**
|
|
252
|
-
* Get the alleged Brand for this
|
|
253
|
-
* Purse
|
|
259
|
+
* Get the alleged Brand for this Purse
|
|
254
260
|
*/
|
|
255
261
|
getAllegedBrand: () => Brand<K>;
|
|
256
262
|
/**
|
|
257
|
-
* Get the amount contained in this
|
|
258
|
-
* purse.
|
|
263
|
+
* Get the amount contained in this purse.
|
|
259
264
|
*/
|
|
260
265
|
getCurrentAmount: () => Amount<K>;
|
|
261
266
|
/**
|
|
262
|
-
* Get a lossy
|
|
263
|
-
* notifier for changes to this purse's balance.
|
|
267
|
+
* Get a lossy notifier for changes to this purse's balance.
|
|
264
268
|
*/
|
|
265
269
|
getCurrentAmountNotifier: () => LatestTopic<Amount<K>>;
|
|
266
270
|
/**
|
|
267
|
-
* Deposit all the contents of payment into
|
|
268
|
-
*
|
|
269
|
-
*
|
|
271
|
+
* Deposit all the contents of payment into this purse, returning the
|
|
272
|
+
* amount. If the optional argument `optAmount` does not equal the
|
|
273
|
+
* amount of digital assets in the payment, throw an error.
|
|
270
274
|
*
|
|
271
275
|
* If payment is a promise, throw an error.
|
|
272
276
|
*/
|
|
273
277
|
deposit: PurseDeposit<K>;
|
|
274
278
|
/**
|
|
275
|
-
* Return an object whose
|
|
276
|
-
* `receive` method deposits to the current Purse.
|
|
279
|
+
* Return an object whose `receive` method deposits to the current Purse.
|
|
277
280
|
*/
|
|
278
281
|
getDepositFacet: () => DepositFacet;
|
|
279
282
|
/**
|
|
280
|
-
* Withdraw amount from
|
|
281
|
-
* this purse into a new Payment.
|
|
283
|
+
* Withdraw amount from this purse into a new Payment.
|
|
282
284
|
*/
|
|
283
285
|
withdraw: (amount: Amount<K>) => Payment<K>;
|
|
284
286
|
/**
|
|
285
|
-
* The set of payments
|
|
286
|
-
*
|
|
287
|
-
*
|
|
288
|
-
*
|
|
289
|
-
*
|
|
290
|
-
*
|
|
291
|
-
*
|
|
292
|
-
* fails.
|
|
287
|
+
* The set of payments withdrawn from this purse that are still live. These
|
|
288
|
+
* are the payments that can still be recovered in emergencies by, for example,
|
|
289
|
+
* depositing into this purse. Such a deposit action is like canceling an
|
|
290
|
+
* outstanding check because you're tired of waiting for it. Once your
|
|
291
|
+
* cancellation is acknowledged, you can spend the assets at stake on other
|
|
292
|
+
* things. Afterwards, if the recipient of the original check finally gets
|
|
293
|
+
* around to depositing it, their deposit fails.
|
|
293
294
|
*/
|
|
294
295
|
getRecoverySet: () => CopySet<Payment<K>>;
|
|
295
296
|
/**
|
|
296
|
-
* For use in emergencies, such as coming
|
|
297
|
-
*
|
|
298
|
-
*
|
|
299
|
-
* of assets recovered.
|
|
297
|
+
* For use in emergencies, such as coming back from a traumatic crash and
|
|
298
|
+
* upgrade. This deposits all the payments in this purse's recovery set
|
|
299
|
+
* into the purse itself, returning the total amount of assets recovered.
|
|
300
300
|
*/
|
|
301
301
|
recoverAll: () => Amount<K>;
|
|
302
302
|
};
|
|
303
303
|
/**
|
|
304
|
-
* Payments hold amount of digital assets of the same
|
|
305
|
-
*
|
|
306
|
-
*
|
|
307
|
-
*
|
|
308
|
-
*
|
|
309
|
-
*
|
|
304
|
+
* Payments hold amount of digital assets of the same brand in transit. Payments
|
|
305
|
+
* can be deposited in purses, split into multiple payments, combined, and
|
|
306
|
+
* claimed (getting an exclusive payment). Payments are linear, meaning
|
|
307
|
+
* that either a payment has the same amount of digital assets it
|
|
308
|
+
* started with, or it is used up entirely. It is impossible to partially use a
|
|
309
|
+
* payment.
|
|
310
310
|
*
|
|
311
|
-
*
|
|
312
|
-
*
|
|
313
|
-
*
|
|
311
|
+
* Payments are often received from other actors and therefore should
|
|
312
|
+
* not be trusted themselves. To get the amount of digital assets in a payment,
|
|
313
|
+
* use the trusted issuer: issuer.getAmountOf(payment),
|
|
314
314
|
*
|
|
315
|
-
*
|
|
316
|
-
*
|
|
317
|
-
*
|
|
315
|
+
* Payments can be converted to Purses by getting a trusted issuer and
|
|
316
|
+
* calling `issuer.makeEmptyPurse()` to create a purse, then
|
|
317
|
+
* `purse.deposit(payment)`.
|
|
318
318
|
*/
|
|
319
319
|
export type Payment<K extends AssetKind = AssetKind> = {
|
|
320
320
|
/**
|
|
321
|
-
* Get the allegedBrand, indicating
|
|
322
|
-
*
|
|
323
|
-
*
|
|
324
|
-
*
|
|
321
|
+
* Get the allegedBrand, indicating the type of digital asset this
|
|
322
|
+
* payment purports to be, and which issuer to use. Because payments
|
|
323
|
+
* are not trusted, any method calls on payments should be treated
|
|
324
|
+
* with suspicion and verified elsewhere.
|
|
325
325
|
*/
|
|
326
326
|
getAllegedBrand: () => Brand<K>;
|
|
327
327
|
};
|
|
328
328
|
/**
|
|
329
|
-
* All of the difference in how digital asset
|
|
330
|
-
*
|
|
331
|
-
*
|
|
332
|
-
*
|
|
333
|
-
*
|
|
334
|
-
*
|
|
329
|
+
* All of the difference in how digital asset amount are manipulated can be
|
|
330
|
+
* reduced to the behavior of the math on values. We extract this
|
|
331
|
+
* custom logic into mathHelpers. MathHelpers are about value
|
|
332
|
+
* arithmetic, whereas AmountMath is about amounts, which are the
|
|
333
|
+
* values labeled with a brand. AmountMath use mathHelpers to do their value
|
|
334
|
+
* arithmetic, and then brand the results, making a new amount.
|
|
335
335
|
*
|
|
336
|
-
*
|
|
337
|
-
*
|
|
338
|
-
*
|
|
336
|
+
* The MathHelpers are designed to be called only from AmountMath, and so
|
|
337
|
+
* all methods but coerce can assume their inputs are valid. They only
|
|
338
|
+
* need to do output validation, and only when there is a possibility of
|
|
339
|
+
* invalid output.
|
|
339
340
|
*/
|
|
340
341
|
export type MathHelpers<V extends AmountValue> = {
|
|
341
342
|
/**
|
|
342
|
-
* Check the kind of this value and
|
|
343
|
-
*
|
|
343
|
+
* Check the kind of this value and throw if it is not the
|
|
344
|
+
* expected kind.
|
|
344
345
|
*/
|
|
345
346
|
doCoerce: (allegedValue: V) => V;
|
|
346
347
|
/**
|
|
347
|
-
* Get the representation for the identity
|
|
348
|
-
*
|
|
348
|
+
* Get the representation for the identity element (often 0 or an
|
|
349
|
+
* empty array)
|
|
349
350
|
*/
|
|
350
351
|
doMakeEmpty: () => V;
|
|
351
352
|
/**
|
|
352
|
-
* Is the value the identity
|
|
353
|
-
* element?
|
|
353
|
+
* Is the value the identity element?
|
|
354
354
|
*/
|
|
355
355
|
doIsEmpty: (value: V) => boolean;
|
|
356
356
|
/**
|
|
357
|
-
* Is the left greater than
|
|
358
|
-
* or equal to the right?
|
|
357
|
+
* Is the left greater than or equal to the right?
|
|
359
358
|
*/
|
|
360
359
|
doIsGTE: (left: V, right: V) => boolean;
|
|
361
360
|
/**
|
|
@@ -363,17 +362,15 @@ export type MathHelpers<V extends AmountValue> = {
|
|
|
363
362
|
*/
|
|
364
363
|
doIsEqual: (left: V, right: V) => boolean;
|
|
365
364
|
/**
|
|
366
|
-
* Return the left combined with the
|
|
367
|
-
* right.
|
|
365
|
+
* Return the left combined with the right.
|
|
368
366
|
*/
|
|
369
367
|
doAdd: (left: V, right: V) => V;
|
|
370
368
|
/**
|
|
371
|
-
* Return what remains after
|
|
372
|
-
*
|
|
373
|
-
* left, we throw an error.
|
|
369
|
+
* Return what remains after removing the right from the left. If
|
|
370
|
+
* something in the right was not in the left, we throw an error.
|
|
374
371
|
*/
|
|
375
372
|
doSubtract: (left: V, right: V) => V;
|
|
376
373
|
};
|
|
377
374
|
export type NatValue = bigint;
|
|
378
|
-
export type SetValue = Key
|
|
375
|
+
export type SetValue = Array<Key>;
|
|
379
376
|
//# sourceMappingURL=types.d.ts.map
|
package/src/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.js"],"names":[],"mappings":";;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.js"],"names":[],"mappings":";;;;;;;;;;;WAiBc,MAAM,CAAC,CAAC;WACR,kBAAkB,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;0BAIrB,QAAQ,WAAc,OAAO,GAAG,OAAO;;;;wBAwBvC,KAAK,GAAG,KAAK,GAAG,SAAS,GAAG,SAAS;qDAOrC,CAAC,SAAS,KAAK,GAAG,QAAQ,GACtC,CAAG,SAAS,KAAK,WACjB,CAAG,SAAS,SAAS,GAAG,OAAO,GAC/B,CAAG,SAAS,SAAS,GAAG,OAAO,GAC/B,KAAO;uDAMK,CAAC,SAAS,QAAQ,GAAG,KAAK,GACtC,CAAI,iBAAoB,KAAK,GAC7B,CAAI,SAAS,OAAO,GAAG,SAAS,GAChC,CAAI,SAAS,OAAO,GAAG,SAAS,GAChC,KAAQ;;;;;;;;;;;;;;;;;;;;eAgBK,CAAC;;;;;;;;;;;;;;;;;gCAkBe,KAAK,MAAM,CAAC,KAAK,QAAQ,OAAO,CAAC;oBAEjD,MAAM,MAAM;;;;oBACZ,MAAM,YAAY,CAAC,CAAC;oBAEpB,MAAM,OAAO;;;;;;;;qCAahB,KAAK,OAAO,CAAC,KACX,QAAQ,OAAO,CAAC;;;;;;;;;+DAalB,KAAK,OAAO,CAAC,KACX,QAAQ,OAAO,CAAC,CAAC,CAAC;;;;;;;;;;;mCAepB,KAAK,OAAO,CAAC,mBACb,OAAO,KACL,QAAQ,MAAM,CAAC;;;;;;;;;;;yDAgBjB,KAAK,QAAQ,CAAC,CAAC,CAAC,mBAChB,OAAO,KACL,QAAQ,QAAQ,CAAC,CAAC,CAAC;;;;;;;iEAYrB,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,6CAEhB,QAAQ,QAAQ,CAAC,CAAC,CAAC;;;;;;;;yDAarB,KAAK,QAAQ,CAAC,CAAC,CAAC,kBAChB,OAAO,CAAC,CAAC,KACP,QAAQ,QAAQ,CAAC,CAAC,EAAE,CAAC;;;;;;;;wCAYvB,KAAK,OAAO,CAAC,WACb,MAAM,EAAE,KACN,QAAQ,OAAO,EAAE,CAAC;;;;;;;;;;;;;;;;;;cAcjB,MAAM,MAAM,CAAC,CAAC;;;;;oBAOd,MAAM,MAAM;;;;;kBAEZ,MAAM,SAAS;;;;;oBAEf,MAAM,YAAY,CAAC,CAAC;;;;;oBAEpB,MAAM,MAAM,CAAC,CAAC;YAEd,YAAY;iBACZ,kBAAkB,CAAC,CAAC;UACpB,UAAU;;;UAMV,KAAK,CAAC,CAAC;uBACP,MAAM,CAAC,CAAC;YACR,OAAO,CAAC,CAAC;WACT,MAAM,CAAC,CAAC;;;UAMR,KAAK,CAAC,CAAC;uBACP,MAAM,CAAC,CAAC;YACR,OAAO,CAAC,CAAC;WACT,MAAM,CAAC,CAAC;iBACR,WAAW;;;;;;;;;;;;;;;;;;kCAoBZ,OAAO,sBAAsB,EAAE,mBAAmB;;;;;;;;;eASjD,MAAM,OAAO,CAAC,CAAC;;;;6BACH,OAAO,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC;;4CAMvC,OAAO,mBACP,OAAO,KACL,MAAM;;;;;;;;;aAKL,mBAAmB;;0DAWtB,QAAQ,CAAC,CAAC,mBACV,OAAO,KACL,OAAO,CAAC,CAAC;;;;;;;;;;;;;;;qBAeR,MAAM,MAAM,CAAC,CAAC;;;;sBAEd,MAAM,OAAO,CAAC,CAAC;;;;8BAGf,MAAM,YAAY,OAAO,CAAC,CAAC,CAAC;;;;;;;;aAG5B,aAAa,CAAC,CAAC;;;;qBAOf,MAAM,YAAY;;;;uBAGT,OAAO,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC;;;;;;;;;;oBAGjC,MAAM,QAAQ,QAAQ,CAAC,CAAC,CAAC;;;;;;gBASzB,MAAM,OAAO,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;qBAwBf,MAAM,MAAM,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;6BAsBC,CAAC,KAAK,CAAC;;;;;iBAItB,MAAM,CAAC;;;;uBAIC,CAAC,KAAK,OAAO;;;;oBAGd,CAAC,SAAS,CAAC,KAAK,OAAO;;;;sBAGvB,CAAC,SAAS,CAAC,KAAK,OAAO;;;;kBAGvB,CAAC,SAAS,CAAC,KAAK,CAAC;;;;;uBAGjB,CAAC,SAAS,CAAC,KAAK,CAAC;;uBAMzB,MAAM;uBAIN,MAAM,GAAG,CAAC"}
|