@leather.io/models 0.10.1 → 0.10.2

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.
Files changed (4) hide show
  1. package/.turbo/turbo-build.log +4 -4
  2. package/CHANGELOG.md +6 -0
  3. package/dist/index.d.ts +38 -0
  4. package/package.json +3 -3
package/.turbo/turbo-build.log CHANGED
@@ -1,5 +1,5 @@
1
1
 
2
- > @leather.io/models@0.10.1 build /home/runner/work/mono/mono/packages/models
2
+ > @leather.io/models@0.10.2 build /home/runner/work/mono/mono/packages/models
3
3
  > tsup
4
4
 
5
5
  CLI Building entry: src/index.ts
@@ -11,7 +11,7 @@
11
11
  ESM Build start
12
12
  ESM dist/index.js 8.12 KB
13
13
  ESM dist/index.js.map 16.65 KB
14
- ESM ⚡️ Build success in 30ms
14
+ ESM ⚡️ Build success in 54ms
15
15
  DTS Build start
16
- DTS ⚡️ Build success in 2261ms
17
- DTS dist/index.d.ts 11.19 KB
16
+ DTS ⚡️ Build success in 2323ms
17
+ DTS dist/index.d.ts 12.43 KB
package/CHANGELOG.md CHANGED
@@ -12,6 +12,12 @@
12
12
  * devDependencies
13
13
  * @leather.io/eslint-config bumped to 0.6.1
14
14
 
15
+ ### Dependencies
16
+
17
+ * The following workspace dependencies were updated
18
+ * devDependencies
19
+ * @leather.io/tsconfig-config bumped to 0.5.1
20
+
15
21
  ## [0.10.0](https://github.com/leather-io/mono/compare/@leather.io/models-v0.9.0...@leather.io/models-v0.10.0) (2024-06-21)
16
22
 
17
23
 
package/dist/index.d.ts CHANGED
@@ -23,24 +23,60 @@ interface Money {
23
23
  }
24
24
 
25
25
  interface BaseCryptoAssetBalance {
26
+ /**
27
+ * totalBalance after filtering out outboundBalance, protectedBalance, and uneconomicalBalance
28
+ */
26
29
  readonly availableBalance: Money;
27
30
  }
28
31
  interface BtcCryptoAssetBalance extends BaseCryptoAssetBalance {
32
+ /**
33
+ * Balance of UTXOs with collectibles
34
+ */
29
35
  readonly protectedBalance: Money;
36
+ /**
37
+ * Balance across UTXOs with need for larger fee than principal by UTXO given standard rate
38
+ */
30
39
  readonly uneconomicalBalance: Money;
31
40
  }
32
41
  interface StxCryptoAssetBalance extends BaseCryptoAssetBalance {
42
+ /**
43
+ * availableBalance minus lockedBalance
44
+ */
33
45
  readonly availableUnlockedBalance: Money;
46
+ /**
47
+ * Balance of pending receipt into account given pending transactions
48
+ */
34
49
  readonly inboundBalance: Money;
50
+ /**
51
+ * totalBalance minus total amount locked by contracts
52
+ */
35
53
  readonly lockedBalance: Money;
54
+ /**
55
+ * Balance of pending delivery from account given pending transactions
56
+ */
36
57
  readonly outboundBalance: Money;
58
+ /**
59
+ * totalBalance plus inboundBalance minus outboundBalance
60
+ */
37
61
  readonly pendingBalance: Money;
62
+ /**
63
+ * Balance as confirmed on chain
64
+ */
38
65
  readonly totalBalance: Money;
66
+ /**
67
+ * totalBalance minus lockedBalance
68
+ */
39
69
  readonly unlockedBalance: Money;
40
70
  }
41
71
  type CryptoAssetBalance = BaseCryptoAssetBalance | BtcCryptoAssetBalance | StxCryptoAssetBalance;
42
72
  declare function createCryptoAssetBalance(balance: Money): BaseCryptoAssetBalance;
43
73
 
74
+ /**
75
+ * Inscriptions contain arbitrary data. When retrieving an inscription, it should be
76
+ * classified into one of the types below, indicating that the app can handle it
77
+ * appropriately and securely. Inscriptions of types not ready to be handled by the
78
+ * app should be classified as "other".
79
+ */
44
80
  declare const inscriptionMimeTypes: readonly ["audio", "gltf", "html", "image", "svg", "text", "video", "other"];
45
81
  type InscriptionMimeType = (typeof inscriptionMimeTypes)[number];
46
82
  declare function whenInscriptionMimeType<T>(mimeType: string, branches: {
@@ -219,7 +255,9 @@ interface BitcoinChainConfig extends BaseChainConfig {
219
255
  interface StacksChainConfig extends BaseChainConfig {
220
256
  blockchain: 'stacks';
221
257
  url: string;
258
+ /** The chainId of the network (or parent network if this is a subnet) */
222
259
  chainId: ChainID;
260
+ /** An additional chainId for subnets. Indicated a subnet if defined and is mainly used for signing. */
223
261
  subnetChainId?: ChainID;
224
262
  }
225
263
  interface NetworkConfiguration {
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@leather.io/models",
3
3
  "author": "Leather.io contact@leather.io",
4
4
  "description": "Leather models and types",
5
- "version": "0.10.1",
5
+ "version": "0.10.2",
6
6
  "license": "MIT",
7
7
  "homepage": "https://github.com/leather-io/mono/tree/dev/packages/models",
8
8
  "repository": {
@@ -24,9 +24,9 @@
24
24
  "prettier": "3.3.0",
25
25
  "tsup": "8.1.0",
26
26
  "typescript": "5.4.5",
27
- "@leather.io/prettier-config": "0.5.0",
28
27
  "@leather.io/eslint-config": "0.6.1",
29
- "@leather.io/tsconfig-config": "0.5.0"
28
+ "@leather.io/prettier-config": "0.5.0",
29
+ "@leather.io/tsconfig-config": "0.5.1"
30
30
  },
31
31
  "keywords": [
32
32
  "leather",