@xyo-network/xl1-wrappers 1.16.13 → 1.16.15

package/README.md

@@ -23,20 +23,15 @@ XYO Layer One SDK Wrappers
 - [BaseWrapper](#classes/BaseWrapper)
 - [FeesWrapper](#classes/FeesWrapper)
 - [SignatureWrapper](#classes/SignatureWrapper)
-- [~~ShiftedBigInt~~](#classes/ShiftedBigInt)
-- [~~XL1Amount~~](#classes/XL1Amount)
 - [ChainWrapper](#classes/ChainWrapper)
 - [HydratedTransactionWrapper](#classes/HydratedTransactionWrapper)
 
 ## Interfaces
 
 - [BaseWrapperConfig](#interfaces/BaseWrapperConfig)
-- [~~XL1AmountInstance~~](#interfaces/XL1AmountInstance)
 
 ## Functions
 
-- [~~splitOnDecimal~~](#functions/splitOnDecimal)
-- [~~splitOnDecimalToString~~](#functions/splitOnDecimalToString)
 - [createSignatureWrappers](#functions/createSignatureWrappers)
 
 ### classes
@@ -106,12 +101,12 @@ protected readonly value: T;
 ### Get Signature
 
 ```ts
-get provider(): undefined | XyoConnection;
+get provider(): XyoConnection | undefined;
 ```
 
 #### Returns
 
-`undefined` \| `XyoConnection`
+`XyoConnection` \| `undefined`
 
 ## Methods
 
@@ -215,7 +210,7 @@ protected new ChainWrapper(value, config): ChainWrapper;
 
 #### value
 
-`Brand`
+`Address`
 
 #### config
 
@@ -246,7 +241,7 @@ protected readonly config: Partial<C>;
 ### value
 
 ```ts
-protected readonly value: Brand;
+protected readonly value: Address;
 ```
 
 ### Inherited from
@@ -260,12 +255,12 @@ protected readonly value: Brand;
 ### Get Signature
 
 ```ts
-get provider(): undefined | XyoConnection;
+get provider(): XyoConnection | undefined;
 ```
 
 #### Returns
 
-`undefined` \| `XyoConnection`
+`XyoConnection` \| `undefined`
 
 ### Inherited from
 
@@ -278,12 +273,12 @@ get provider(): undefined | XyoConnection;
 ### Get Signature
 
 ```ts
-get id(): Brand;
+get id(): Address;
 ```
 
 #### Returns
 
-`Brand`
+`Address`
 
 ## Methods
 
@@ -658,16 +653,12 @@ HydratedTransactionInstance.externalPayloads
 ### Get Signature
 
 ```ts
-get from(): Brand<Brand<Lowercase<string>, {
-}>, {
-}>;
+get from(): Address;
 ```
 
 #### Returns
 
-`Brand`\<`Brand`\<`Lowercase`\<`string`\>, \{
-\}\>, \{
-\}\>
+`Address`
 
 ***
 
@@ -696,12 +687,12 @@ HydratedTransactionInstance.payloadCount
 ### Get Signature
 
 ```ts
-get payloads(): WithHashStorageMeta<WithStorageMeta<T[1][number]>>[];
+get payloads(): WithHashMeta<WithStorageMeta<T[1][number]>>[];
 ```
 
 #### Returns
 
-`WithHashStorageMeta`\<`WithStorageMeta`\<`T`\[`1`\]\[`number`\]\>\>[]
+`WithHashMeta`\<`WithStorageMeta`\<`T`\[`1`\]\[`number`\]\>\>[]
 
 ### Implementation of
 
@@ -822,9 +813,7 @@ static parse<T>(transaction, validate): Promise<HydratedTransactionInstance<[T[0
 ### elevatedPayload()
 
 ```ts
-elevatedPayload(index): 
-  | undefined
-| WithHashStorageMeta<AllowedBlockPayload & T[1][number]>;
+elevatedPayload(index): WithHashMeta<AllowedBlockPayload & T[1][number]> | undefined;
 ```
 
 ### Parameters
@@ -835,8 +824,7 @@ elevatedPayload(index):
 
 ### Returns
 
-  \| `undefined`
-  \| `WithHashStorageMeta`\<AllowedBlockPayload & T\[1\]\[number\]\>
+`WithHashMeta`\<AllowedBlockPayload & T\[1\]\[number\]\> \| `undefined`
 
 ### Implementation of
 
@@ -861,7 +849,7 @@ gasRequired(): bigint;
 ### payload()
 
 ```ts
-payload(index): undefined | WithStorageMeta<Payload>;
+payload(index): WithStorageMeta<Payload> | undefined;
 ```
 
 ### Parameters
@@ -872,7 +860,7 @@ payload(index): undefined | WithStorageMeta<Payload>;
 
 ### Returns
 
-`undefined` \| `WithStorageMeta`\<`Payload`\>
+`WithStorageMeta`\<`Payload`\> \| `undefined`
 
 ### Implementation of
 
@@ -903,7 +891,7 @@ HydratedTransactionInstance.reward
 ### signature()
 
 ```ts
-signature(index): undefined | SignatureInstance;
+signature(index): SignatureInstance | undefined;
 ```
 
 ### Parameters
@@ -914,7 +902,7 @@ signature(index): undefined | SignatureInstance;
 
 ### Returns
 
-`undefined` \| `SignatureInstance`
+`SignatureInstance` \| `undefined`
 
 ### Implementation of
 
@@ -945,7 +933,7 @@ HydratedTransactionInstance.validate
 ### parse()
 
 ```ts
-protected parse(validate): Promise<HydratedTransactionInstance<[WithHashStorageMeta<T[0]>, WithHashStorageMeta<T[1][number]>[]], AllowedBlockPayload>>;
+protected parse(validate): Promise<HydratedTransactionInstance<[WithHashMeta<T[0]>, WithHashMeta<T[1][number]>[]], AllowedBlockPayload>>;
 ```
 
 ### Parameters
@@ -956,169 +944,7 @@ protected parse(validate): Promise<HydratedTransactionInstance<[WithHashStorageM
 
 ### Returns
 
-`Promise`\<`HydratedTransactionInstance`\<\[`WithHashStorageMeta`\<`T`\[`0`\]\>, `WithHashStorageMeta`\<`T`\[`1`\]\[`number`\]\>[]\], `AllowedBlockPayload`\>\>
-
-  ### <a id="ShiftedBigInt"></a>ShiftedBigInt
-
-[**@xyo-network/xl1-wrappers**](#../README)
-
-***
-
-## Deprecated
-
-use from @xyo-network/xl1-protocol instead
-
-## Constructors
-
-### Constructor
-
-```ts
-new ShiftedBigInt(value, config): ShiftedBigInt;
-```
-
-### Parameters
-
-#### value
-
-`bigint` | `ShiftedBigInt`
-
-#### config
-
-`Partial`\<`ShiftedBigIntConfig`\> = `{}`
-
-### Returns
-
-`ShiftedBigInt`
-
-## Properties
-
-### ~~defaultConfig~~
-
-```ts
-readonly static defaultConfig: ShiftedBigIntConfig;
-```
-
-***
-
-### ~~config~~
-
-```ts
-config: ShiftedBigIntConfig;
-```
-
-***
-
-### ~~value~~
-
-```ts
-value: bigint;
-```
-
-## Accessors
-
-### ~~locale~~
-
-### Get Signature
-
-```ts
-get locale(): LocalesArgument;
-```
-
-#### Returns
-
-`LocalesArgument`
-
-***
-
-### ~~maxCharacters~~
-
-### Get Signature
-
-```ts
-get maxCharacters(): number;
-```
-
-#### Returns
-
-`number`
-
-***
-
-### ~~maxDecimal~~
-
-### Get Signature
-
-```ts
-get maxDecimal(): number;
-```
-
-#### Returns
-
-`number`
-
-***
-
-### ~~minDecimals~~
-
-### Get Signature
-
-```ts
-get minDecimals(): number;
-```
-
-#### Returns
-
-`number`
-
-***
-
-### ~~places~~
-
-### Get Signature
-
-```ts
-get places(): number;
-```
-
-#### Returns
-
-`number`
-
-## Methods
-
-### ~~toFullString()~~
-
-```ts
-toFullString(): string;
-```
-
-### Returns
-
-`string`
-
-***
-
-### ~~toShortString()~~
-
-```ts
-toShortString(): string;
-```
-
-### Returns
-
-`string`
-
-***
-
-### ~~toString()~~
-
-```ts
-toString(): string;
-```
-
-### Returns
-
-`string`
+`Promise`\<`HydratedTransactionInstance`\<\[`WithHashMeta`\<`T`\[`0`\]\>, `WithHashMeta`\<`T`\[`1`\]\[`number`\]\>[]\], `AllowedBlockPayload`\>\>
 
   ### <a id="SignatureWrapper"></a>SignatureWrapper
 
@@ -1145,15 +971,15 @@ new SignatureWrapper(
 
 #### signature
 
-`Brand`
+`Hex`
 
 #### address
 
-`Brand`
+`Address`
 
 #### hash
 
-`Brand`
+`Hash`
 
 ### Returns
 
@@ -1164,7 +990,7 @@ new SignatureWrapper(
 ### address
 
 ```ts
-address: Brand;
+address: Address;
 ```
 
 ### Implementation of
@@ -1178,7 +1004,7 @@ SignatureInstance.address
 ### hash
 
 ```ts
-hash: Brand;
+hash: Hash;
 ```
 
 ### Implementation of
@@ -1192,7 +1018,7 @@ SignatureInstance.hash
 ### signature
 
 ```ts
-signature: Brand;
+signature: Hex;
 ```
 
 ### Implementation of
@@ -1216,15 +1042,15 @@ signature): Promise<Error[]>;
 
 #### hash
 
-`Brand`
+`Hash`
 
 #### address
 
-`Brand`
+`Address`
 
 #### signature
 
-`Brand`
+`Hex`
 
 ### Returns
 
@@ -1248,576 +1074,58 @@ validate(): Promise<Error[]>;
 SignatureInstance.validate
 ```
 
-  ### <a id="XL1Amount"></a>XL1Amount
-
-[**@xyo-network/xl1-wrappers**](#../README)
-
-***
-
-## Deprecated
-
-use from @xyo-network/xl1-protocol instead
-
-## Implements
-
-- [`XL1AmountInstance`](#../interfaces/XL1AmountInstance)
-
-## Constructors
-
-### Constructor
-
-```ts
-new XL1Amount(value, locale): XL1Amount;
-```
-
-### Parameters
-
-#### value
-
-`bigint`
-
-#### locale
-
-`LocalesArgument` = `'en-US'`
-
-### Returns
-
-`XL1Amount`
-
-## Properties
-
-### ~~value~~
-
-```ts
-value: AttoXL1;
-```
-
-### Implementation of
-
-[`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`value`](../interfaces/XL1AmountInstance.md#value)
-
-## Accessors
-
-### ~~milli~~
-
-### Get Signature
-
-```ts
-get milli(): MilliXL1;
-```
-
-#### Returns
-
-`MilliXL1`
+### functions
 
-### Implementation of
+  ### <a id="createSignatureWrappers"></a>createSignatureWrappers
 
-[`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`milli`](../interfaces/XL1AmountInstance.md#milli)
+[**@xyo-network/xl1-wrappers**](#../README)
 
 ***
 
-### ~~micro~~
-
-### Get Signature
-
 ```ts
-get micro(): MicroXL1;
+function createSignatureWrappers(bw): Promise<SignatureInstance[]>;
 ```
 
-#### Returns
-
-`MicroXL1`
-
-### Implementation of
-
-[`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`micro`](../interfaces/XL1AmountInstance.md#micro)
-
-***
+## Parameters
 
-### ~~nano~~
+### bw
 
-### Get Signature
+`BoundWitness`
 
-```ts
-get nano(): NanoXL1;
-```
+## Returns
 
-#### Returns
+`Promise`\<`SignatureInstance`[]\>
 
-`NanoXL1`
+### interfaces
 
-### Implementation of
+  ### <a id="BaseWrapperConfig"></a>BaseWrapperConfig
 
-[`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`nano`](../interfaces/XL1AmountInstance.md#nano)
+[**@xyo-network/xl1-wrappers**](#../README)
 
 ***
 
-### ~~pico~~
-
-### Get Signature
-
-```ts
-get pico(): PicoXL1;
-```
-
-#### Returns
-
-`PicoXL1`
-
-### Implementation of
+## Type Parameters
 
-[`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`pico`](../interfaces/XL1AmountInstance.md#pico)
+### T
 
-***
+`T`
 
-### ~~femto~~
+## Properties
 
-### Get Signature
+### provider
 
 ```ts
-get femto(): FemtoXL1;
+provider: XyoConnection;
 ```
 
-#### Returns
-
-`FemtoXL1`
-
-### Implementation of
-
-[`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`femto`](../interfaces/XL1AmountInstance.md#femto)
-
 ***
 
-### ~~atto~~
-
-### Get Signature
-
-```ts
-get atto(): AttoXL1;
-```
-
-#### Returns
-
-`AttoXL1`
-
-### Implementation of
-
-[`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`atto`](../interfaces/XL1AmountInstance.md#atto)
-
-## Methods
-
-### ~~from()~~
+### value
 
 ```ts
-static from(value, places): XL1Amount;
+value: T;
 ```
 
-### Parameters
-
-#### value
-
-`bigint`
-
-#### places
-
-`bigint` = `XL1Places.atto`
-
-### Returns
-
-`XL1Amount`
-
-***
-
-### ~~fromMilli()~~
-
-```ts
-static fromMilli(value): XL1Amount;
-```
-
-### Parameters
-
-#### value
-
-`MilliXL1`
-
-### Returns
-
-`XL1Amount`
-
-***
-
-### ~~fromMicro()~~
-
-```ts
-static fromMicro(value): XL1Amount;
-```
-
-### Parameters
-
-#### value
-
-`MicroXL1`
-
-### Returns
-
-`XL1Amount`
-
-***
-
-### ~~fromNano()~~
-
-```ts
-static fromNano(value): XL1Amount;
-```
-
-### Parameters
-
-#### value
-
-`NanoXL1`
-
-### Returns
-
-`XL1Amount`
-
-***
-
-### ~~fromPico()~~
-
-```ts
-static fromPico(value): XL1Amount;
-```
-
-### Parameters
-
-#### value
-
-`PicoXL1`
-
-### Returns
-
-`XL1Amount`
-
-***
-
-### ~~fromFemto()~~
-
-```ts
-static fromFemto(value): XL1Amount;
-```
-
-### Parameters
-
-#### value
-
-`FemtoXL1`
-
-### Returns
-
-`XL1Amount`
-
-***
-
-### ~~fromAtto()~~
-
-```ts
-static fromAtto(value): XL1Amount;
-```
-
-### Parameters
-
-#### value
-
-`AttoXL1`
-
-### Returns
-
-`XL1Amount`
-
-***
-
-### ~~to()~~
-
-```ts
-to(places): bigint;
-```
-
-### Parameters
-
-#### places
-
-`number` | `bigint`
-
-### Returns
-
-`bigint`
-
-### Implementation of
-
-[`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`to`](../interfaces/XL1AmountInstance.md#to)
-
-***
-
-### ~~toString()~~
-
-```ts
-toString(places, config): string;
-```
-
-### Parameters
-
-#### places
-
-`number` = `...`
-
-#### config
-
-`Partial`\<`ShiftedBigIntConfig`\> = `{}`
-
-### Returns
-
-`string`
-
-### Implementation of
-
-[`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`toString`](../interfaces/XL1AmountInstance.md#tostring)
-
-### functions
-
-  ### <a id="createSignatureWrappers"></a>createSignatureWrappers
-
-[**@xyo-network/xl1-wrappers**](#../README)
-
-***
-
-```ts
-function createSignatureWrappers(bw): Promise<SignatureInstance[]>;
-```
-
-## Parameters
-
-### bw
-
-`BoundWitness`
-
-## Returns
-
-`Promise`\<`SignatureInstance`[]\>
-
-  ### <a id="splitOnDecimal"></a>splitOnDecimal
-
-[**@xyo-network/xl1-wrappers**](#../README)
-
-***
-
-```ts
-function splitOnDecimal(value, places): [bigint, bigint];
-```
-
-## Parameters
-
-### value
-
-`bigint`
-
-### places
-
-`number` = `18`
-
-## Returns
-
-\[`bigint`, `bigint`\]
-
-## Deprecated
-
-use from @xyo-network/xl1-protocol instead
-
-  ### <a id="splitOnDecimalToString"></a>splitOnDecimalToString
-
-[**@xyo-network/xl1-wrappers**](#../README)
-
-***
-
-```ts
-function splitOnDecimalToString(
-   value, 
-   places, 
-   maxDecimal, 
-   maxCharacters, 
-   minDecimals, 
-   locale): string;
-```
-
-## Parameters
-
-### value
-
-`bigint`
-
-### places
-
-`number` = `18`
-
-### maxDecimal
-
-`number` = `places`
-
-### maxCharacters
-
-`number` = `9`
-
-### minDecimals
-
-`number` = `1`
-
-### locale
-
-`LocalesArgument` = `'en-US'`
-
-## Returns
-
-`string`
-
-## Deprecated
-
-use from @xyo-network/xl1-protocol instead
-
-### interfaces
-
-  ### <a id="BaseWrapperConfig"></a>BaseWrapperConfig
-
-[**@xyo-network/xl1-wrappers**](#../README)
-
-***
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Properties
-
-### provider
-
-```ts
-provider: XyoConnection;
-```
-
-***
-
-### value
-
-```ts
-value: T;
-```
-
-  ### <a id="XL1AmountInstance"></a>XL1AmountInstance
-
-[**@xyo-network/xl1-wrappers**](#../README)
-
-***
-
-## Deprecated
-
-use from @xyo-network/xl1-protocol instead
-
-## Properties
-
-### ~~value~~
-
-```ts
-value: AttoXL1;
-```
-
-***
-
-### ~~milli~~
-
-```ts
-milli: MilliXL1;
-```
-
-***
-
-### ~~micro~~
-
-```ts
-micro: MicroXL1;
-```
-
-***
-
-### ~~nano~~
-
-```ts
-nano: NanoXL1;
-```
-
-***
-
-### ~~pico~~
-
-```ts
-pico: PicoXL1;
-```
-
-***
-
-### ~~femto~~
-
-```ts
-femto: FemtoXL1;
-```
-
-***
-
-### ~~atto~~
-
-```ts
-atto: AttoXL1;
-```
-
-## Methods
-
-### ~~to()~~
-
-```ts
-to(places): bigint;
-```
-
-### Parameters
-
-#### places
-
-`number` | `bigint`
-
-### Returns
-
-`bigint`
-
-***
-
-### ~~toString()~~
-
-```ts
-toString(places, config): string;
-```
-
-### Parameters
-
-#### places
-
-`number`
-
-#### config
-
-`Partial`\<`ShiftedBigIntConfig`\>
-
-### Returns
-
-`string`
-
 
 ## Maintainers
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json.schemastore.org/package.json",
   "name": "@xyo-network/xl1-wrappers",
-  "version": "1.16.13",
+  "version": "1.16.15",
   "description": "XYO Layer One SDK Wrappers",
   "homepage": "https://xylabs.com",
   "bugs": {
@@ -36,14 +36,14 @@
     "src"
   ],
   "dependencies": {
-    "@xylabs/sdk-js": "~5.0.33",
-    "@xyo-network/boundwitness-model": "~5.1.22",
-    "@xyo-network/boundwitness-validator": "~5.1.22",
-    "@xyo-network/payload-builder": "~5.1.22",
-    "@xyo-network/payload-model": "~5.1.22",
+    "@xylabs/sdk-js": "~5.0.34",
+    "@xyo-network/boundwitness-model": "~5.1.23",
+    "@xyo-network/boundwitness-validator": "~5.1.23",
+    "@xyo-network/payload-builder": "~5.1.23",
+    "@xyo-network/payload-model": "~5.1.23",
     "@xyo-network/xl1-protocol": "~1.13.11",
-    "@xyo-network/xl1-protocol-sdk": "~1.16.13",
-    "@xyo-network/xl1-validation": "~1.16.13"
+    "@xyo-network/xl1-protocol-sdk": "~1.16.15",
+    "@xyo-network/xl1-validation": "~1.16.15"
   },
   "devDependencies": {
     "@types/node": "~24.10.1",