Skip to content

Commit c0d7455

Browse files
authored
Merge pull request #530 from aeternity/fix_aens_update_documentation
Clarify and correct docs on AENSUpdateTx
2 parents e38ee2a + 5c2b7e4 commit c0d7455

File tree

2 files changed

+17
-4
lines changed

2 files changed

+17
-4
lines changed

AENS.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -291,8 +291,7 @@ pre-claimed|auction ---> claimed
291291

292292
The pointers field in the name entry:
293293
* On `claim` transaction, is initialized to the empty dictionary.
294-
* On `update` transaction, is replaced with the pointers in the transaction,
295-
keeping the order in the transaction.
294+
* On `update` transaction, is replaced with the pointers in the transaction.
296295

297296
Note that `expire` is not an explicit message that is part
298297
of the protocol.
@@ -523,6 +522,12 @@ From Iris protocol upgrade, the following limitations on pointers apply:
523522
From Ceres hardfork, a new pointer target type is introduced:
524523
- A key can point to up to 1024 bytes of uninterpreted data (a bytearray)
525524

525+
Note: An update containing the new pointer target type MUST use version 2 of
526+
the
527+
[serialization](serializations.md#name-service-update-transaction-version-2);
528+
and, an update _not_ containing the new target type MUST use version 1 of the
529+
[serialization](serializations.md#name-service-update-transaction-version-1).
530+
526531
#### Transfer
527532

528533
```

serializations.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -533,7 +533,11 @@ Note: From Ceres protocol version `contract` can be a name (where the
533533
]
534534
```
535535

536-
#### Name service update transaction (version 1, until Ceres release)
536+
#### Name service update transaction - version 1
537+
538+
This is the serialization of an AENS Update transaction that does not contain
539+
raw data pointers.
540+
537541
```
538542
[ <account> :: id()
539543
, <nonce> :: int()
@@ -546,7 +550,11 @@ Note: From Ceres protocol version `contract` can be a name (where the
546550
]
547551
```
548552

549-
#### Name service update transaction (version 2, from Ceres release)
553+
#### Name service update transaction - version 2
554+
555+
Introduced in Ceres protocol; this is the serialization of an AENS Update
556+
transaction that contains one or more raw data pointers.
557+
550558
```
551559
[ <account> :: id()
552560
, <nonce> :: int()

0 commit comments

Comments
 (0)