@settlemint/dalp-sdk 3.1.26-main.39717604394 → 3.1.26-main.39728385283

package/README.md

@@ -155,6 +155,32 @@ declaration says one lives rather than guessing from a field name.
 `OrganizationId` is the only entity id branded end to end across the platform;
 every other identifier crossing this boundary is a plain string.
 
+Request and response types brand the wire scalars the API validates, so a raw
+string does not compile where the API wants an address, hash or amount. Build the
+brand with a constructor, which throws a `DalpSdkError` (code
+`sdk.scalar.EVM_ADDRESS_INVALID` for an address, `sdk.scalar.VALUE_INVALID` for
+the rest) when the value is not valid, or narrow with the matching guard:
+
+```ts
+import { evmAddress, integerString, isEvmAddress } from "@settlemint/dalp-sdk/scalars";
+
+await dalp.api.token.mint({
+  assetId: evmAddress("0x52908400098527886e0f7030069857d2e4169ee7"),
+  recipients: evmAddress("0x5A0b54D5dc17e0AadC383d2db43B0a0D3E029c4c"),
+  amounts: integerString(1000n),
+});
+
+const value: unknown = await readFromSomewhere();
+if (isEvmAddress(value)) {
+  await dalp.api.token.mint({ assetId: value, recipients: value, amounts: "100" });
+}
+```
+
+The constructors are `evmAddress`, `ethereumHash`, `ethereumHex`,
+`cantonPartyId`, `fiatCurrency`, `networkId`, `timestamp`, `integerString` and
+`decimalString`; each has an `is...` guard, such as `isEthereumHash`. Integer
+text is typed `${bigint}` and decimal text `${number}`.
+
 ## Auth
 
 ```ts

package/dist/auth.js

@@ -17,7 +17,7 @@ import {
   makeCookieStore2,
   createCookieStoreFetch2,
   SDK_USER_AGENT2
-} from "./chunk-hmjes1ct.js";
+} from "./chunk-em0bmf8p.js";
 import {
   normalizeDalpBaseUrl
 } from "./chunk-h9e65x5z.js";