Skip to main content
Version: 3.1.0

Build Record

Build Record​

IPNS Build Record Builds a new record from provided data and signs it. This function requires inputs as follows:

  • Value 1 : UTF-8 String, the actual value pointed to by the name. Usually an IPFS CID or another IPNS name.
  • Validity 2 : UTF-8 String, How long the IPNS name is valid. This can be updated when the record is republished.
  • Sequence 3 : uint64, The iteration this record is on. Starts at 1 with the first publishing and increases by 1 with every republish.
  • Ttl 4 : uint64, this is a DNS-related term better explained here. The default value is 300 (5 minutes).
  • Private Key (PEM) 5 : Byte array, they private key used to sign the record in PEM encoding.
  • Additional Metadata 6 : String to IPLD Node object map, additional metadata that can be attached to the record. The keys should be prefixed with underscore '_' symbol, but it is not enforced.
danger

Record maximum size is 10KiB. Additional Metadata should not contain large values.

IPNS Build Record

If successful, returns the IPNS Record 7 which is the signed data structure, ready for publishing.