diff --git a/functions/index.createIPNSRecord.html b/functions/index.createIPNSRecord.html index b3130ca..a9910e1 100644 --- a/functions/index.createIPNSRecord.html +++ b/functions/index.createIPNSRecord.html @@ -1,10 +1,10 @@ createIPNSRecord | ipns

Function createIPNSRecord

  • createIPNSRecord(privateKey, value, seq, lifetime, options?): Promise<IPNSRecordV1V2>

  • Creates a new IPNS record and signs it with the given private key. The IPNS Record validity should follow the [RFC3339]https://www.ietf.org/rfc/rfc3339.txt with nanoseconds precision. Note: This function does not embed the public key. If you want to do that, use EmbedPublicKey.

    -

    The passed value can be a CID, a PeerID or an arbitrary string path.

    +

    The passed value can be a CID, a PublicKey or an arbitrary string path e.g. /ipfs/... or /ipns/....

    • CIDs will be converted to v1 and stored in the record as a string similar to: /ipfs/${cid}
      • -
    • PeerIDs will create recursive records, eg. the record value will be /ipns/${cidV1Libp2pKey}
      • +
    • PublicKeys will create recursive records, eg. the record value will be /ipns/${cidV1Libp2pKey}
    • String paths will be stored in the record as-is, but they must start with "/"

    Parameters

    • privateKey: PrivateKey

      the private key for signing the record.

      @@ -12,4 +12,4 @@
    • seq: number | bigint

      number representing the current version of the record.

    • lifetime: number

      lifetime of the record (in milliseconds).

    • Optional options: CreateV2OrV1Options

      additional create options.

      -

    Returns Promise<IPNSRecordV1V2>

  • createIPNSRecord(privateKey, value, seq, lifetime, options): Promise<IPNSRecordV2>

  • Parameters

    Returns Promise<IPNSRecordV2>

  • createIPNSRecord(privateKey, value, seq, lifetime, options): Promise<IPNSRecordV1V2>

  • Parameters

    Returns Promise<IPNSRecordV1V2>

Settings

Member Visibility

Theme

\ No newline at end of file +

Returns Promise<IPNSRecordV1V2>

  • createIPNSRecord(privateKey, value, seq, lifetime, options): Promise<IPNSRecordV2>

  • Parameters

    Returns Promise<IPNSRecordV2>

  • createIPNSRecord(privateKey, value, seq, lifetime, options): Promise<IPNSRecordV1V2>

  • Parameters

    Returns Promise<IPNSRecordV1V2>

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/index.createIPNSRecordWithExpiration.html b/functions/index.createIPNSRecordWithExpiration.html index c0c04e9..a061362 100644 --- a/functions/index.createIPNSRecordWithExpiration.html +++ b/functions/index.createIPNSRecordWithExpiration.html @@ -1,9 +1,9 @@ createIPNSRecordWithExpiration | ipns

    Function createIPNSRecordWithExpiration

    • createIPNSRecordWithExpiration(privateKey, value, seq, expiration, options?): Promise<IPNSRecordV1V2>

    • Same as create(), but instead of generating a new Date, it receives the intended expiration time WARNING: nano precision is not standard, make sure the value in seconds is 9 orders of magnitude lesser than the one provided.

      -

      The passed value can be a CID, a PeerID or an arbitrary string path.

      +

      The passed value can be a CID, a PublicKey or an arbitrary string path e.g. /ipfs/... or /ipns/....

      • CIDs will be converted to v1 and stored in the record as a string similar to: /ipfs/${cid}
        • -
      • PeerIDs will create recursive records, eg. the record value will be /ipns/${cidV1Libp2pKey}
        • +
      • PublicKeys will create recursive records, eg. the record value will be /ipns/${cidV1Libp2pKey}
      • String paths will be stored in the record as-is, but they must start with "/"

      Parameters

      • privateKey: PrivateKey

        the private key for signing the record.

        @@ -11,4 +11,4 @@
      • seq: number | bigint

        number representing the current version of the record.

      • expiration: string

        expiration datetime for record in the [RFC3339]https://www.ietf.org/rfc/rfc3339.txt with nanoseconds precision.

      • Optional options: CreateV2OrV1Options

        additional creation options.

        -

      Returns Promise<IPNSRecordV1V2>

    • createIPNSRecordWithExpiration(privateKey, value, seq, expiration, options): Promise<IPNSRecordV2>

    • Parameters

      Returns Promise<IPNSRecordV2>

    • createIPNSRecordWithExpiration(privateKey, value, seq, expiration, options): Promise<IPNSRecordV1V2>

    • Parameters

      Returns Promise<IPNSRecordV1V2>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<IPNSRecordV1V2>

  • createIPNSRecordWithExpiration(privateKey, value, seq, expiration, options): Promise<IPNSRecordV2>

  • Parameters

    Returns Promise<IPNSRecordV2>

  • createIPNSRecordWithExpiration(privateKey, value, seq, expiration, options): Promise<IPNSRecordV1V2>

  • Parameters

    Returns Promise<IPNSRecordV1V2>

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/index.extractPublicKeyFromIPNSRecord.html b/functions/index.extractPublicKeyFromIPNSRecord.html index 7168051..01ce76b 100644 --- a/functions/index.extractPublicKeyFromIPNSRecord.html +++ b/functions/index.extractPublicKeyFromIPNSRecord.html @@ -1,3 +1,3 @@ extractPublicKeyFromIPNSRecord | ipns

    Function extractPublicKeyFromIPNSRecord

    • extractPublicKeyFromIPNSRecord(record): PublicKey | undefined

    • Extracts a public key from the passed PeerId, falling back to the pubKey embedded in the ipns record

      -

      Parameters

      Returns PublicKey | undefined

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns PublicKey | undefined

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/index.marshalIPNSRecord.html b/functions/index.marshalIPNSRecord.html index effe1d9..13a9133 100644 --- a/functions/index.marshalIPNSRecord.html +++ b/functions/index.marshalIPNSRecord.html @@ -1 +1 @@ -marshalIPNSRecord | ipns

    Function marshalIPNSRecord

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +marshalIPNSRecord | ipns

    Function marshalIPNSRecord

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/index.multihashFromIPNSRoutingKey.html b/functions/index.multihashFromIPNSRoutingKey.html index 37bf28a..5366315 100644 --- a/functions/index.multihashFromIPNSRoutingKey.html +++ b/functions/index.multihashFromIPNSRoutingKey.html @@ -1 +1 @@ -multihashFromIPNSRoutingKey | ipns

    Function multihashFromIPNSRoutingKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +multihashFromIPNSRoutingKey | ipns

    Function multihashFromIPNSRoutingKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/index.multihashToIPNSRoutingKey.html b/functions/index.multihashToIPNSRoutingKey.html index efd5642..814faef 100644 --- a/functions/index.multihashToIPNSRoutingKey.html +++ b/functions/index.multihashToIPNSRoutingKey.html @@ -1 +1 @@ -multihashToIPNSRoutingKey | ipns

    Function multihashToIPNSRoutingKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +multihashToIPNSRoutingKey | ipns

    Function multihashToIPNSRoutingKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/index.unmarshalIPNSRecord.html b/functions/index.unmarshalIPNSRecord.html index 9f5d7a4..8f7a11d 100644 --- a/functions/index.unmarshalIPNSRecord.html +++ b/functions/index.unmarshalIPNSRecord.html @@ -1 +1 @@ -unmarshalIPNSRecord | ipns

    Function unmarshalIPNSRecord

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +unmarshalIPNSRecord | ipns

    Function unmarshalIPNSRecord

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/selector.ipnsSelector.html b/functions/selector.ipnsSelector.html index 9e98f45..9214d59 100644 --- a/functions/selector.ipnsSelector.html +++ b/functions/selector.ipnsSelector.html @@ -1 +1,10 @@ -ipnsSelector | ipns

    Function ipnsSelector

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ipnsSelector | ipns

    Function ipnsSelector

    • ipnsSelector(key, data): number

    • Selects the latest valid IPNS record from an array of marshalled IPNS records.

      +

      Records are sorted by:

      +
        +
      1. Sequence number (higher takes precedence)
        2. +
      2. Validity time for EOL records with same sequence number (longer lived record takes precedence)
        3. +
      +

      Parameters

      • key: Uint8Array

        The routing key for the IPNS record

        +
      • data: Uint8Array[]

        Array of marshalled IPNS records to select from

        +

      Returns number

      The index of the most valid record from the input array

      +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/validator.ipnsValidator.html b/functions/validator.ipnsValidator.html index 7af8054..c1c01d6 100644 --- a/functions/validator.ipnsValidator.html +++ b/functions/validator.ipnsValidator.html @@ -1 +1,5 @@ -ipnsValidator | ipns

    Function ipnsValidator

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ipnsValidator | ipns

    Function ipnsValidator

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/validator.validate.html b/functions/validator.validate.html index 8fb040b..39e6667 100644 --- a/functions/validator.validate.html +++ b/functions/validator.validate.html @@ -1,3 +1,3 @@ -validate | ipns

    Function validate

    • validate(publicKey, buf): Promise<void>

    • Validates the given IPNS Record against the given public key. We need a "raw" +validate | ipns

      Function validate

      • validate(publicKey, marshalledRecord): Promise<void>

      • Validates the given IPNS Record against the given public key. We need a "raw" record in order to be able to access to all of its fields.

        -

        Parameters

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

      Parameters

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/index.html b/index.html index 1fcbdd2..b952fcb 100644 --- a/index.html +++ b/index.html @@ -13,23 +13,15 @@
  • Usage
    • -
  • API @@ -39,72 +31,29 @@ 
    <script src="https://unpkg.com/ipns/dist/index.min.js"></script>

    This module contains all the necessary code for creating, understanding and validating IPNS records.

    -

    Usage

    Create record

    import * as ipns from 'ipns'

    const ipnsRecord = await ipns.create(privateKey, value, sequenceNumber, lifetime)
+
    Usage
    Create record
    import * as ipns from 'ipns'

    const ipnsRecord = await ipns.createIPNSRecord(privateKey, value, sequenceNumber, lifetime)
 
    
-
    Validate record
    import * as ipns from 'ipns'

    await ipns.validate(publicKey, marshalledData)
    // if no error thrown, the record is valid
+
    Validate record against public key
    import { validate } from 'ipns/validator'

    await validate(publicKey, marshalledRecord)
    // if no error thrown, the record is valid
 
    
-
    Embed public key to record
    import * as ipns from 'ipns'

    const ipnsRecordWithEmbeddedPublicKey = await ipns.embedPublicKey(publicKey, ipnsRecord)
+
    Validate record against routing key
    This is useful when validating IPNS names that use RSA keys, whose public key is embedded in the record (rather than in the routing key as with Ed25519).
    
+
    import { ipnsValidator } from 'ipns/validator'

    await ipnsValidator(routingKey, marshalledRecord)
 
    
-
    Extract public key from record
    import * as ipns from 'ipns'

    const publicKey = await ipns.extractPublicKey(peerId, ipnsRecord)
+
    Extract public key from record
    import * as ipns from 'ipns'

    const publicKey = await ipns.extractPublicKeyFromIPNSRecord(peerId, ipnsRecord)
 
    
-
    Marshal data with proto buffer
    import * as ipns from 'ipns'

    const ipnsRecord = await ipns.create(privateKey, value, sequenceNumber, lifetime)
    // ...
    const marshalledData = ipns.marshal(ipnsRecord)
    // ...
+
    Marshal data with proto buffer
    import * as ipns from 'ipns'

    const ipnsRecord = await ipns.createIPNSRecord(privateKey, value, sequenceNumber, lifetime)
    // ...
    const marshalledData = ipns.marshalIPNSRecord(ipnsRecord)
    // ...
 
    
 
    Returns the record data serialized.
    
-
    Unmarshal data from proto buffer
    import * as ipns from 'ipns'

    const ipnsRecord = ipns.unmarshal(storedData)
+
    Unmarshal data from proto buffer
    import * as ipns from 'ipns'

    const ipnsRecord = ipns.unmarshalIPNSRecord(storedData)
 
    
 
    Returns the IPNSRecord after being deserialized.
    
-
    Validator
    import * as ipns from 'ipns'

    const validator = ipns.validator
-
    
-
    Contains an object with validate (marshalledData, key) and select (dataA, dataB) functions.
    
-
    The validate async function aims to verify if an IPNS record is valid. First the record is unmarshalled, then the public key is obtained and finally the record is validated (signatureV2 of CBOR data is verified).
    
-
    The select function is responsible for deciding which IPNS record is the best (newer) between two records. Both records are unmarshalled and their sequence numbers are compared. If the first record provided is the newer, the operation result will be 0, otherwise the operation result will be 1.
    
-
    API
    Create record

    ipns.create(privateKey, value, sequenceNumber, lifetime, options)
-
    
-
    Create an IPNS record for being stored in a protocol buffer.
    
-
      
-
    • privateKey (PrivateKey): key to be used for cryptographic operations.
      • 
-
    • value (string): IPFS path of the object to be published.
      • 
-
    • sequenceNumber (Number): number representing the current version of the record.
      • 
-
    • lifetime (Number): lifetime of the record (in milliseconds).
      • 
-
    • options (CreateOptions): additional creation options.
      • 
-
    
-
    Returns a Promise that resolves to an object with a IPNSRecord.
    
-
    Validate record
    ipns.validate(publicKey, ipnsRecord)
-
    
-
    Validate an IPNS record previously stored in a protocol buffer.
    
-
      
-
    • publicKey (PublicKey): key to be used for cryptographic operations.
      • 
-
    • ipnsRecord (IPNSRecord): IPNS record (obtained using the create function).
      • 
-
    
-
    Returns a Promise, which may be rejected if the validation was not successful.
    
-
    Marshal data with proto buffer
    const marshalledData = ipns.marshal(ipnsRecord)
-
    
-
    Returns the serialized IPNS record.
    
-
      
-
    • ipnsRecord (IPNSRecord): ipns record (obtained using the create function).
      • 
-
    
-
    Unmarshal data from proto buffer
    const data = ipns.unmarshal(storedData)
-
    
-
    Returns a IPNSRecord after being serialized.
    
-
      
-
    • storedData (Uint8Array): ipns record serialized.
      • 
-
    
-
    Extract public key from record
    const publicKey = await ipns.extractPublicKey(peerId, ipnsRecord)
-
    
-
    Extract a public key from an IPNS record.
    
-
      
-
    • peerId (PeerId): peer identifier object.
      • 
-
    • ipnsRecord (IPNSRecord): ipns record (obtained using the create function).
      • 
+
      API Docs
      
-
      Returns a Promise which resolves to public key (PublicKey ): may be used for cryptographic operations.
      
 
      Namespace
      Namespace constants for records.
      
 
      ipns.namespace

      // '/ipns/'
 
      
 
      ipns.namespaceLength

      // 6
 
      
-
      API Docs
      
 
      License
      Licensed under either of
      
 
        
 
      • Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
        • 
@@ -115,4 +64,4 @@
 
        Please be aware that all interactions related to this repo are subject to the IPFS Code of Conduct.
        
 
        Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
        
 
        
-
        Settings
        Member Visibility
        Theme
        On This Page
        ipns 
        
\ No newline at end of file
+
        Settings
        Member Visibility
        Theme
        On This Page
        ipns 
        
\ No newline at end of file
diff --git a/interfaces/index.CreateOptions.html b/interfaces/index.CreateOptions.html
index 7a5e74b..a870469 100644
--- a/interfaces/index.CreateOptions.html
+++ b/interfaces/index.CreateOptions.html
@@ -1,3 +1,3 @@
-CreateOptions | ipns
        Interface CreateOptions
        interface CreateOptions { 
            ttlNs?: number | bigint; 
            v1Compatible?: boolean; 
        }
        Properties
        ttlNs?
+CreateOptions | ipns
        Interface CreateOptions
        interface CreateOptions { 
            ttlNs?: number | bigint; 
            v1Compatible?: boolean; 
        }
        Properties
        ttlNs?
 v1Compatible?
-
        Properties
        Optional ttlNs
        ttlNs?: number | bigint
        Optional v1Compatible
        v1Compatible?: boolean
        Settings
        Member Visibility
        Theme
        On This Page
        ttlNsv1Compatible
        
\ No newline at end of file
+
        Properties
        Optional ttlNs
        ttlNs?: number | bigint
        Optional v1Compatible
        v1Compatible?: boolean
        Settings
        Member Visibility
        Theme
        On This Page
        ttlNsv1Compatible
        
\ No newline at end of file
diff --git a/interfaces/index.CreateV2Options.html b/interfaces/index.CreateV2Options.html
index b2c27c2..a046ea9 100644
--- a/interfaces/index.CreateV2Options.html
+++ b/interfaces/index.CreateV2Options.html
@@ -1,2 +1,2 @@
-CreateV2Options | ipns
        Interface CreateV2Options
        interface CreateV2Options { 
            v1Compatible: false; 
        }
        Properties
        v1Compatible
-
        Properties
        v1Compatible
        v1Compatible: false
        Settings
        Member Visibility
        Theme
        On This Page
        v1Compatible
        
\ No newline at end of file
+CreateV2Options | ipns
        Interface CreateV2Options
        interface CreateV2Options { 
            v1Compatible: false; 
        }
        Properties
        v1Compatible
+
        Properties
        v1Compatible
        v1Compatible: false
        Settings
        Member Visibility
        Theme
        On This Page
        v1Compatible
        
\ No newline at end of file
diff --git a/interfaces/index.CreateV2OrV1Options.html b/interfaces/index.CreateV2OrV1Options.html
index de0acad..c46cec9 100644
--- a/interfaces/index.CreateV2OrV1Options.html
+++ b/interfaces/index.CreateV2OrV1Options.html
@@ -1,2 +1,2 @@
-CreateV2OrV1Options | ipns
        Interface CreateV2OrV1Options
        interface CreateV2OrV1Options { 
            v1Compatible: true; 
        }
        Properties
        v1Compatible
-
        Properties
        v1Compatible
        v1Compatible: true
        Settings
        Member Visibility
        Theme
        On This Page
        v1Compatible
        
\ No newline at end of file
+CreateV2OrV1Options | ipns
        Interface CreateV2OrV1Options
        interface CreateV2OrV1Options { 
            v1Compatible: true; 
        }
        Properties
        v1Compatible
+
        Properties
        v1Compatible
        v1Compatible: true
        Settings
        Member Visibility
        Theme
        On This Page
        v1Compatible
        
\ No newline at end of file
diff --git a/interfaces/index.IDKeys.html b/interfaces/index.IDKeys.html
index a19b4dd..9b469a8 100644
--- a/interfaces/index.IDKeys.html
+++ b/interfaces/index.IDKeys.html
@@ -1,5 +1,5 @@
-IDKeys | ipns
        Interface IDKeys
        interface IDKeys { 
            ipnsKey: Key; 
            pkKey: Key; 
            routingKey: Key; 
            routingPubKey: Key; 
        }
        Properties
        ipnsKey
+IDKeys | ipns
        Interface IDKeys
        interface IDKeys { 
            ipnsKey: Key; 
            pkKey: Key; 
            routingKey: Key; 
            routingPubKey: Key; 
        }
        Properties
        ipnsKey
 pkKey
 routingKey
 routingPubKey
-
        Properties
        ipnsKey
        ipnsKey: Key
        pkKey
        pkKey: Key
        routingKey
        routingKey: Key
        routingPubKey
        routingPubKey: Key
        Settings
        Member Visibility
        Theme
        On This Page
        ipnsKeypkKeyroutingKeyroutingPubKey
        
\ No newline at end of file
+
        Properties
        ipnsKey
        ipnsKey: Key
        pkKey
        pkKey: Key
        routingKey
        routingKey: Key
        routingPubKey
        routingPubKey: Key
        Settings
        Member Visibility
        Theme
        On This Page
        ipnsKeypkKeyroutingKeyroutingPubKey
        
\ No newline at end of file
diff --git a/interfaces/index.IPNSRecordData.html b/interfaces/index.IPNSRecordData.html
index aa10c20..7874a18 100644
--- a/interfaces/index.IPNSRecordData.html
+++ b/interfaces/index.IPNSRecordData.html
@@ -1,6 +1,6 @@
-IPNSRecordData | ipns
        Interface IPNSRecordData
        interface IPNSRecordData { 
            Sequence: bigint; 
            TTL: bigint; 
            Validity: Uint8Array; 
            ValidityType: EOL; 
            Value: Uint8Array; 
        }
        Properties
        Sequence
+IPNSRecordData | ipns
        Interface IPNSRecordData
        interface IPNSRecordData { 
            Sequence: bigint; 
            TTL: bigint; 
            Validity: Uint8Array; 
            ValidityType: EOL; 
            Value: Uint8Array; 
        }
        Properties
        Sequence
 TTL
 Validity
 ValidityType
 Value
-
        Properties
        Sequence
        Sequence: bigint
        TTL
        TTL: bigint
        Validity
        Validity: Uint8Array
        ValidityType
        ValidityType: EOL
        Value
        Value: Uint8Array
        Settings
        Member Visibility
        Theme
        On This Page
        SequenceTTLValidityValidityTypeValue
        
\ No newline at end of file
+
        Properties
        Sequence
        Sequence: bigint
        TTL
        TTL: bigint
        Validity
        Validity: Uint8Array
        ValidityType
        ValidityType: EOL
        Value
        Value: Uint8Array
        Settings
        Member Visibility
        Theme
        On This Page
        SequenceTTLValidityValidityTypeValue
        
\ No newline at end of file
diff --git a/interfaces/index.IPNSRecordV1V2.html b/interfaces/index.IPNSRecordV1V2.html
index 9b9bd3b..604f22c 100644
--- a/interfaces/index.IPNSRecordV1V2.html
+++ b/interfaces/index.IPNSRecordV1V2.html
@@ -1,4 +1,4 @@
-IPNSRecordV1V2 | ipns
        Interface IPNSRecordV1V2
        interface IPNSRecordV1V2 { 
            data: Uint8Array; 
            pubKey?: Uint8Array; 
            sequence: bigint; 
            signatureV1: Uint8Array; 
            signatureV2: Uint8Array; 
            ttl?: bigint; 
            validity: string; 
            validityType: EOL; 
            value: string; 
        }
        Properties
        data
+IPNSRecordV1V2 | ipns
        Interface IPNSRecordV1V2
        interface IPNSRecordV1V2 { 
            data: Uint8Array; 
            pubKey?: Uint8Array; 
            sequence: bigint; 
            signatureV1: Uint8Array; 
            signatureV2: Uint8Array; 
            ttl?: bigint; 
            validity: string; 
            validityType: EOL; 
            value: string; 
        }
        Properties
        data
 pubKey?
 sequence
 signatureV1
@@ -8,12 +8,12 @@
 validityType
 value
 
        Properties
        data
        data: Uint8Array
        extensible data
        
-
        Optional pubKey
        pubKey?: Uint8Array
        the public portion of the key that signed this record (only present if it was not embedded in the IPNS key)
        
-
        sequence
        sequence: bigint
        number representing the version of the record
        
-
        signatureV1
        signatureV1: Uint8Array
        signature of the record
        
-
        signatureV2
        signatureV2: Uint8Array
        the v2 signature of the record
        
-
        Optional ttl
        ttl?: bigint
        ttl in nanoseconds
        
-
        validity
        validity: string
        expiration datetime for the record in RFC3339 format
        
-
        validityType
        validityType: EOL
        Type of validation being used
        
-
        value
        value: string
        value of the record
        
-
        Settings
        Member Visibility
        Theme
        On This Page
        datapubKeysequencesignatureV1signatureV2ttlvalidityvalidityTypevalue
        
\ No newline at end of file
+
        Optional pubKey
        pubKey?: Uint8Array
        the public portion of the key that signed this record (only present if it was not embedded in the IPNS key)
        
+
        sequence
        sequence: bigint
        number representing the version of the record
        
+
        signatureV1
        signatureV1: Uint8Array
        signature of the record
        
+
        signatureV2
        signatureV2: Uint8Array
        the v2 signature of the record
        
+
        Optional ttl
        ttl?: bigint
        ttl in nanoseconds
        
+
        validity
        validity: string
        expiration datetime for the record in RFC3339 format
        
+
        validityType
        validityType: EOL
        Type of validation being used
        
+
        value
        value: string
        value of the record
        
+
        Settings
        Member Visibility
        Theme
        On This Page
        datapubKeysequencesignatureV1signatureV2ttlvalidityvalidityTypevalue
        
\ No newline at end of file
diff --git a/interfaces/index.IPNSRecordV2.html b/interfaces/index.IPNSRecordV2.html
index 68b8bd2..52c09ad 100644
--- a/interfaces/index.IPNSRecordV2.html
+++ b/interfaces/index.IPNSRecordV2.html
@@ -1,4 +1,4 @@
-IPNSRecordV2 | ipns
        Interface IPNSRecordV2
        interface IPNSRecordV2 { 
            data: Uint8Array; 
            pubKey?: Uint8Array; 
            sequence: bigint; 
            signatureV2: Uint8Array; 
            ttl?: bigint; 
            validity: string; 
            validityType: EOL; 
            value: string; 
        }
        Properties
        data
+IPNSRecordV2 | ipns
        Interface IPNSRecordV2
        interface IPNSRecordV2 { 
            data: Uint8Array; 
            pubKey?: Uint8Array; 
            sequence: bigint; 
            signatureV2: Uint8Array; 
            ttl?: bigint; 
            validity: string; 
            validityType: EOL; 
            value: string; 
        }
        Properties
        data
 pubKey?
 sequence
 signatureV2
@@ -7,12 +7,12 @@
 validityType
 value
 
        Properties
        data
        data: Uint8Array
        extensible data
        
-
        Optional pubKey
        pubKey?: Uint8Array
        the public portion of the key that signed this record (only present if it was not embedded in the IPNS key)
        
-
        sequence
        sequence: bigint
        number representing the version of the record
        
-
        signatureV2
        signatureV2: Uint8Array
        the v2 signature of the record
        
-
        Optional ttl
        ttl?: bigint
        ttl in nanoseconds
        
-
        validity
        validity: string
        If the validity type is EOL, this is the expiration datetime for the record
+
        Optional pubKey
        pubKey?: Uint8Array
        the public portion of the key that signed this record (only present if it was not embedded in the IPNS key)
        
+
        sequence
        sequence: bigint
        number representing the version of the record
        
+
        signatureV2
        signatureV2: Uint8Array
        the v2 signature of the record
        
+
        Optional ttl
        ttl?: bigint
        ttl in nanoseconds
        
+
        validity
        validity: string
        If the validity type is EOL, this is the expiration datetime for the record
 in RFC3339 format
        
-
        validityType
        validityType: EOL
        Type of validation being used
        
-
        value
        value: string
        value of the record
        
-
        Settings
        Member Visibility
        Theme
        On This Page
        datapubKeysequencesignatureV2ttlvalidityvalidityTypevalue
        
\ No newline at end of file
+
        validityType
        validityType: EOL
        Type of validation being used
        
+
        value
        value: string
        value of the record
        
+
        Settings
        Member Visibility
        Theme
        On This Page
        datapubKeysequencesignatureV2ttlvalidityvalidityTypevalue
        
\ No newline at end of file
diff --git a/modules/index.html b/modules/index.html
index 02c4d7c..0f38f81 100644
--- a/modules/index.html
+++ b/modules/index.html
@@ -1,4 +1,4 @@
-index | ipns
        Module index
        Index
        Interfaces
        CreateOptions
+index | ipns
        Module index
        Index
        Interfaces
        CreateOptions
 CreateV2Options
 CreateV2OrV1Options
 IDKeys
diff --git a/modules/selector.html b/modules/selector.html
index 394dfa5..b35ea9b 100644
--- a/modules/selector.html
+++ b/modules/selector.html
@@ -1,2 +1,2 @@
-selector | ipns
        Module selector
        Index
        Functions
        ipnsSelector
+selector | ipns
        Module selector
        Index
        Functions
        ipnsSelector
 
        Settings
        Member Visibility
        Theme
        
\ No newline at end of file
diff --git a/modules/validator.html b/modules/validator.html
index 58decc5..0b36629 100644
--- a/modules/validator.html
+++ b/modules/validator.html
@@ -1,3 +1,3 @@
-validator | ipns
        Module validator
        Index
        Functions
        ipnsValidator
+validator | ipns
        Module validator
        Index
        Functions
        ipnsValidator
 validate
 
        Settings
        Member Visibility
        Theme
        
\ No newline at end of file
diff --git a/types/index.IPNSRecord.html b/types/index.IPNSRecord.html
index 890257b..7c22875 100644
--- a/types/index.IPNSRecord.html
+++ b/types/index.IPNSRecord.html
@@ -1 +1 @@
-IPNSRecord | ipns
        Type alias IPNSRecord
        IPNSRecord: IPNSRecordV1V2 | IPNSRecordV2
        Settings
        Member Visibility
        Theme
        
\ No newline at end of file
+IPNSRecord | ipns
        Type alias IPNSRecord
        IPNSRecord: IPNSRecordV1V2 | IPNSRecordV2
        Settings
        Member Visibility
        Theme
        
\ No newline at end of file
diff --git a/variables/index.namespace.html b/variables/index.namespace.html
index f174c73..a1fd6bc 100644
--- a/variables/index.namespace.html
+++ b/variables/index.namespace.html
@@ -1 +1 @@
-namespace | ipns
        Variable namespaceConst 
        namespace: "/ipns/" = '/ipns/'
        Settings
        Member Visibility
        Theme
        
\ No newline at end of file
+namespace | ipns
        Variable namespaceConst 
        namespace: "/ipns/" = '/ipns/'
        Settings
        Member Visibility
        Theme
        
\ No newline at end of file
diff --git a/variables/index.namespaceLength.html b/variables/index.namespaceLength.html
index 54a0ab4..8a8804b 100644
--- a/variables/index.namespaceLength.html
+++ b/variables/index.namespaceLength.html
@@ -1 +1 @@
-namespaceLength | ipns
        Variable namespaceLengthConst 
        namespaceLength: number = namespace.length
        Settings
        Member Visibility
        Theme
        
\ No newline at end of file
+namespaceLength | ipns
        Variable namespaceLengthConst 
        namespaceLength: number = namespace.length
        Settings
        Member Visibility
        Theme
        
\ No newline at end of file