EXTERNAL-ISSUER is a pointer-declaration Reference that cites a LOCAL ID in a document published by an Issuer, without IMPORT, using a single record.

ItemValue
NameEXTERNAL-ISSUER-4WORD (a 5Q bundle. See the member table below for the name of each code)
TAG ID0x034L~0x038L
Section1 0001 (Reference EXTERNAL), offset within section C = 20~24
KindReference · category: pointer-declaration
Hugo sidereference/external-issuer.md (that page also covers EXTERNAL-ISSUER-2WORD and EXTERNAL-ISSUER-16WORD)

Members

This page covers one 5Q set, five codes together. The quantification is the offset within the section, C % 5 (Reference). There is one codec document per code. The fields of the five codec documents are the same; only the DECLARE target and the name (BIND) differ.

TAG IDNameQuantificationCodec IDSpec documentTAG WORD
0x034LEXTERNAL-ISSUER-4WORD-IDENTIFIEDIdentified0x000003400x00000000/codecs/0x00000340/0000 0011 0100 LLLL
0x035LEXTERNAL-ISSUER-4WORD-GENERICGeneric0x000003500x00000000/codecs/0x00000350/0000 0011 0101 LLLL
0x036LEXTERNAL-ISSUER-4WORD-FREE-CHOICEFree-choice0x000003600x00000000/codecs/0x00000360/0000 0011 0110 LLLL
0x037LEXTERNAL-ISSUER-4WORD-UNIVERSALUniversal0x000003700x00000000/codecs/0x00000370/0000 0011 0111 LLLL
0x038LEXTERNAL-ISSUER-4WORD-VARIABLEVariable0x000003800x00000000/codecs/0x00000380/0000 0011 1000 LLLL

Fields (spec document)

The order of FIELDs in the document is the order of Payload fields (Codec spec document).

OrderField (BIND)FIELDWidthAccepted form (CODEC)ENUM
1issuer#2Raw value, 4 WORD
2doc#3Raw value, 4 WORD
3target-id#4Remaining raw value (0xFFFF)

EXTERNAL-ISSUER is a pointer-declaration Reference that cites a LOCAL ID in a document published by an Issuer, without IMPORT. A single record is complete in meaning and follows the latest version.

Layout

TAG WORD          0000 001C CCCC LLLL      Codec 0x02FL~0x03DL (section 1)
[Length extension TAG]
Issuer            width set by the Codec (2/4/16 WORD)
Document ID       4 WORD
Target ID         all the rest. LOCAL ID in that document, shortest width
Codec (Identified, Generic, Free-choice, Universal, Variable)NameIssuer width
0x02FL~0x033LEXTERNAL-ISSUER-2WORD2 WORD (registered with geul.org, domain proof)
0x034L~0x038LEXTERNAL-ISSUER-4WORD4 WORD (registered with geul.org, no proof)
0x039L~0x03DLEXTERNAL-ISSUER-16WORD16 WORD (computed from a public key)
  • The width is set by the scheme number: if the scheme − 9 (C / 5 − 3 of the offset within the section C) is 0, 1, or 2, the width is 2, 4, or 16 WORD. The quantification is C % 5.
  • The Issuer ID is an integer value. The same value is the same Issuer. Write the Issuer in the shortest width that fits the value, and choose the Codec of that width (4 WORD only at 2^32 or above, 16 WORD only at 2^64 or above). A notation in a wider width is invalid (Issuer).
  • geul.org handles Issuer registration and management.
  • No version is written; it follows the latest version. To pin the version, use IMPORT-DOC and EXTERNAL-POINTER.
  • The location is found by the publication address rule (Publication addresses and version list).
  • The same LOCAL ID of that document is the same target whether it is written as a LOCAL inside that document, as an EXTERNAL-ISSUER in another document (or as an EXTERNAL-POINTER after IMPORT).
  • It points only to a LOCAL of a document. A document itself is pointed to by DOC-POINTER, and an Issuer itself by ISSUER-POINTER. So the target ID is not 0. Document ID 0 is the term-definition index document of the Issuer.

Validity

  • It is invalid if the Issuer width does not match the Codec, or if the value fits a narrower width.
  • A target ID of 0 is invalid. Target ID 0 (the document itself) is handled by DOC-POINTER.
  • A leading 0x0000 WORD in the target ID is forbidden.

Examples

TargetWORD sequence
Issuer 0x00000002, document 0x…0002, LOCAL 702F7 0000 0002 0000 0000 0000 0002 0007
Issuer 0x00012345, document 0x…0002, LOCAL 702F7 0001 2345 0000 0000 0000 0002 0007

Related pages

Spec document source

This is the spec document 0x00000000/codecs/0x00000340/latest.geul as read by geul show (hex in uppercase).

SPEC-VERSION 0x0001
DOC-ID 0x0426000000000000034000000000
BODY
#1 DECLARE 0x0340
#2 FIELD #1 0x0004
#3 FIELD #1 0x0004
#4 FIELD #1 rest
#5 BIND #1 "EXTERNAL-ISSUER-4WORD-IDENTIFIED"
#6 BIND #2 "issuer"
#7 BIND #3 "doc"
#8 BIND #4 "target-id"

The above is the codec document of EXTERNAL-ISSUER-4WORD-IDENTIFIED (0x034L). The codec documents of the other members (EXTERNAL-ISSUER-4WORD-GENERIC, EXTERNAL-ISSUER-4WORD-FREE-CHOICE, EXTERNAL-ISSUER-4WORD-UNIVERSAL, EXTERNAL-ISSUER-4WORD-VARIABLE) differ only in the codec ID of the DOC-ID, the DECLARE target, and the name bound in #1 (BIND).