@neuraiproject/neurai-assets 1.3.2 → 1.4.0

package/README.md

@@ -2,6 +2,12 @@
 
 Complete asset management library for Neurai blockchain. Supports creation, reissuance, and queries for all asset types in a non-custodial way.
 
+> **1.4.0**: NIP-040 `assetMarker` in `localRawBuild` (see below); RPC
+> rejection messages from `@neuraiproject/neurai-rpc` >= 0.5 are surfaced
+> correctly (they carry no `.message`); name-length caps now mirror the node
+> (full name, owner `!` included: 31 mainnet / 121 testnet-regtest, validated
+> against a regtest node); peer `neurai-rpc ^0.6.0`.
+
 ## Features
 
 - ✅ **Non-custodial**: Library builds unsigned transactions, your wallet signs them
@@ -183,6 +189,28 @@ const result = await assets.createDepinAsset({
 > **Note**: DEPIN assets always use `units = 0`. Recipient and change destinations
 > can be either legacy or AuthScript, as long as they belong to the same chain family.
 
+### Transfer Asset
+
+```javascript
+// Works for any asset type (regular, sub, restricted, DePIN).
+const result = await assets.transferAsset({
+  assetName: 'MYTOKEN',
+  recipients: [
+    { address: 'nM...', amount: 5 },   // amount in display units
+    { address: 'nQ...', amount: 2.5 }
+  ]
+  // changeAddress is optional; defaults to the configured change address.
+  // Asset change and the network fee are handled automatically.
+});
+```
+
+> **DePIN (`&`) note**: DePIN assets are soulbound — the transfer is only valid
+> if it is authorized by the owner. `transferAsset` handles this automatically:
+> it spends the asset's owner token (`&NAME!`) and returns it to the change
+> address, so authority stays with the sender. You must hold the owner token, or
+> the call throws `OwnerTokenNotFoundError`. Transferring ownership itself (handing
+> the owner token to the recipient) is not done here.
+
 ### Create UNIQUE Assets (NFTs)
 
 ```javascript
@@ -503,6 +531,26 @@ The library automatically validates that the owner token is returned in each ope
 
 **Note**: In addition to the burned cost, all operations pay a network fee (calculated automatically).
 
+## NIP-040 asset marker (local raw builds)
+
+Asset payloads open with a 3-byte marker that NIP-040 migrates from the
+Ravencoin-inherited `rvn` to `xna` at an activation height per network
+(testnet: 303000, already crossed; regtest: 1; mainnet: not scheduled yet).
+
+- Transactions built **through the node** (`createrawtransaction`) need
+  nothing: the node stamps the marker itself.
+- The `localRawBuild` metadata (consumed by
+  `@neuraiproject/neurai-create-transaction createFromOperation`, >= 0.7.0)
+  now carries `params.assetMarker`. Builders resolve it once per build:
+  1. `params.assetMarker` / `config.assetMarker` if you set it (`'rvn'` |
+     `'xna'` — offline builds or tests);
+  2. otherwise the node's `getblockchaininfo.asset_marker` (node commit
+     `347362b` or later);
+  3. `'rvn'` when the node predates that field or the call fails — which
+     matches what such a node enforces.
+
+No height tables and no network inference: the node (or you) decides.
+
 ## Validations
 
 The library validates client-side: