refactor: change value from bytes array to string

Author: hacdias

README.md

@@ -143,7 +143,7 @@ ipns.create(privateKey, value, sequenceNumber, lifetime, options)
 Create an IPNS record for being stored in a protocol buffer.
 
 - `privateKey` (`PrivKey` [RSA Instance](https://github.com/libp2p/js-libp2p-crypto/blob/master/src/keys/rsa-class.js)): key to be used for cryptographic operations.
-- `value` (Uint8Array): ipfs path of the object to be published.
+- `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.

src/index.ts

@@ -88,12 +88,12 @@ const defaultCreateOptions: CreateOptions = {
  * Note: This function does not embed the public key. If you want to do that, use `EmbedPublicKey`.
  *
  * @param {PeerId} peerId - peer id containing private key for signing the record.
- * @param {Uint8Array} value - value to be stored in the record.
+ * @param {string} value - value to be stored in the record.
  * @param {number | bigint} seq - number representing the current version of the record.
  * @param {number} lifetime - lifetime of the record (in milliseconds).
  * @param {CreateOptions} options - additional create options.
  */
-export const create = async (peerId: PeerId, value: Uint8Array, seq: number | bigint, lifetime: number, options: CreateOptions = defaultCreateOptions): Promise<IPNSRecord> => {
+export const create = async (peerId: PeerId, value: string, seq: number | bigint, lifetime: number, options: CreateOptions = defaultCreateOptions): Promise<IPNSRecord> => {
   // Validity in ISOString with nanoseconds precision and validity type EOL
   const expirationDate = new NanoDate(Date.now() + Number(lifetime))
   const validityType = IpnsEntry.ValidityType.EOL
@@ -108,12 +108,12 @@ export const create = async (peerId: PeerId, value: Uint8Array, seq: number | bi
  * WARNING: nano precision is not standard, make sure the value in seconds is 9 orders of magnitude lesser than the one provided.
  *
  * @param {PeerId} peerId - PeerId containing private key for signing the record.
- * @param {Uint8Array} value - value to be stored in the record.
+ * @param {string} value - value to be stored in the record.
  * @param {number | bigint} seq - number representing the current version of the record.
  * @param {string} expiration - expiration datetime for record in the [RFC3339]{@link https://www.ietf.org/rfc/rfc3339.txt} with nanoseconds precision.
  * @param {CreateOptions} options - additional creation options.
  */
-export const createWithExpiration = async (peerId: PeerId, value: Uint8Array, seq: number | bigint, expiration: string, options: CreateOptions = defaultCreateOptions): Promise<IPNSRecord> => {
+export const createWithExpiration = async (peerId: PeerId, value: string, seq: number | bigint, expiration: string, options: CreateOptions = defaultCreateOptions): Promise<IPNSRecord> => {
   const expirationDate = NanoDate.fromString(expiration)
   const validityType = IpnsEntry.ValidityType.EOL
 
@@ -123,16 +123,17 @@ export const createWithExpiration = async (peerId: PeerId, value: Uint8Array, se
   return _create(peerId, value, seq, validityType, expirationDate, ttlNs, options)
 }
 
-const _create = async (peerId: PeerId, value: Uint8Array, seq: number | bigint, validityType: IpnsEntry.ValidityType, expirationDate: NanoDate, ttl: bigint, options: CreateOptions = defaultCreateOptions): Promise<IPNSRecord> => {
+const _create = async (peerId: PeerId, value: string, seq: number | bigint, validityType: IpnsEntry.ValidityType, expirationDate: NanoDate, ttl: bigint, options: CreateOptions = defaultCreateOptions): Promise<IPNSRecord> => {
   seq = BigInt(seq)
   const isoValidity = uint8ArrayFromString(expirationDate.toString())
+  const encodedValue = uint8ArrayFromString(value)
 
   if (peerId.privateKey == null) {
     throw errCode(new Error('Missing private key'), ERRORS.ERR_MISSING_PRIVATE_KEY)
   }
 
   const privateKey = await unmarshalPrivateKey(peerId.privateKey)
-  const data = createCborData(value, isoValidity, validityType, seq, ttl)
+  const data = createCborData(encodedValue, isoValidity, validityType, seq, ttl)
   const sigData = ipnsRecordDataForV2Sig(data)
   const signatureV2 = await privateKey.sign(sigData)
 
@@ -142,8 +143,8 @@ const _create = async (peerId: PeerId, value: Uint8Array, seq: number | bigint,
   }
 
   if (options.v1Compatible === true) {
-    const signatureV1 = await signLegacyV1(privateKey, value, validityType, isoValidity)
-    pb.value = value
+    const signatureV1 = await signLegacyV1(privateKey, encodedValue, validityType, isoValidity)
+    pb.value = encodedValue
     pb.validity = isoValidity
     pb.validityType = validityType
     pb.signatureV1 = signatureV1

test/index.spec.ts

@@ -7,7 +7,6 @@ import { createEd25519PeerId } from '@libp2p/peer-id-factory'
 import { expect } from 'aegir/chai'
 import { base58btc } from 'multiformats/bases/base58'
 import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
-import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
 import * as ERRORS from '../src/errors.js'
 import * as ipns from '../src/index.js'
 import { IpnsEntry } from '../src/pb/ipns.js'
@@ -18,7 +17,7 @@ import type { PeerId } from '@libp2p/interface-peer-id'
 describe('ipns', function () {
   this.timeout(20 * 1000)
 
-  const cid = uint8ArrayFromString('QmWEekX7EZLUd9VXRNMRXW3LXe4F6x7mB8oPxY5XLptrBq')
+  const contentPath = '/ipfs/bafkqae3imvwgy3zamzzg63janjzs22lqnzzqu'
   let peerId: PeerId
 
   before(async () => {
@@ -30,16 +29,16 @@ describe('ipns', function () {
     const sequence = 0
     const validity = 1000000
 
-    const record = await ipns.create(peerId, cid, sequence, validity)
+    const record = await ipns.create(peerId, contentPath, sequence, validity)
 
-    expect(record.value()).to.equal(uint8ArrayToString(cid))
+    expect(record.value()).to.equal(contentPath)
     expect(record.sequence()).to.equal(BigInt(0))
     expect(record.validityType()).to.equal(IpnsEntry.ValidityType.EOL)
     expect(record.validity()).to.exist()
     expect(record.ttl()).to.equal(BigInt(validity * 100000))
 
     expect(record.pb).to.deep.include({
-      value: cid,
+      value: uint8ArrayFromString(contentPath),
       sequence: BigInt(sequence)
     })
     expect(record.pb).to.have.property('validity')
@@ -53,9 +52,9 @@ describe('ipns', function () {
     const sequence = 0
     const validity = 1000000
 
-    const record = await ipns.create(peerId, cid, sequence, validity, { v1Compatible: false })
+    const record = await ipns.create(peerId, contentPath, sequence, validity, { v1Compatible: false })
 
-    expect(record.value()).to.equal(uint8ArrayToString(cid))
+    expect(record.value()).to.equal(contentPath)
     expect(record.sequence()).to.equal(BigInt(0))
     expect(record.validityType()).to.equal(IpnsEntry.ValidityType.EOL)
     expect(record.validity()).to.exist()
@@ -75,7 +74,7 @@ describe('ipns', function () {
     // 2033-05-18T03:33:20.000000000Z
     const expiration = '2033-05-18T03:33:20.000000000Z'
 
-    const record = await ipns.createWithExpiration(peerId, cid, sequence, expiration)
+    const record = await ipns.createWithExpiration(peerId, contentPath, sequence, expiration)
 
     await ipnsValidator(peerIdToRoutingKey(peerId), marshal(record))
     expect(record.pb).to.have.property('validity')
@@ -87,7 +86,7 @@ describe('ipns', function () {
     // 2033-05-18T03:33:20.000000000Z
     const expiration = '2033-05-18T03:33:20.000000000Z'
 
-    const record = await ipns.createWithExpiration(peerId, cid, sequence, expiration, { v1Compatible: false })
+    const record = await ipns.createWithExpiration(peerId, contentPath, sequence, expiration, { v1Compatible: false })
 
     await ipnsValidator(peerIdToRoutingKey(peerId), marshal(record))
     expect(record.pb).to.not.have.property('validity')
@@ -98,23 +97,23 @@ describe('ipns', function () {
     const sequence = 0
     const validity = 1000000
 
-    const record = await ipns.create(peerId, cid, sequence, validity)
+    const record = await ipns.create(peerId, contentPath, sequence, validity)
     await ipnsValidator(peerIdToRoutingKey(peerId), marshal(record))
   })
 
   it('should create an ipns record (V2) and validate it correctly', async () => {
     const sequence = 0
     const validity = 1000000
 
-    const record = await ipns.create(peerId, cid, sequence, validity, { v1Compatible: false })
+    const record = await ipns.create(peerId, contentPath, sequence, validity, { v1Compatible: false })
     await ipnsValidator(peerIdToRoutingKey(peerId), marshal(record))
   })
 
   it('should fail to validate a v1 (deprecated legacy) message', async () => {
     const sequence = 0
     const validity = 1000000
 
-    const record = await ipns.create(peerId, cid, sequence, validity)
+    const record = await ipns.create(peerId, contentPath, sequence, validity)
 
     // remove the extra fields added for v2 sigs
     delete record.pb.data
@@ -130,7 +129,7 @@ describe('ipns', function () {
     const sequence = 0
     const validity = 1000000
 
-    const record = await ipns.create(peerId, cid, sequence, validity)
+    const record = await ipns.create(peerId, contentPath, sequence, validity)
 
     // remove v2 sig
     delete record.pb.signatureV2
@@ -145,7 +144,7 @@ describe('ipns', function () {
     const sequence = 0
     const validity = 1000000
 
-    const record = await ipns.create(peerId, cid, sequence, validity)
+    const record = await ipns.create(peerId, contentPath, sequence, validity)
 
     // corrupt the record by changing the value to random bytes
     record.pb.value = randomBytes(46)
@@ -157,7 +156,7 @@ describe('ipns', function () {
     const sequence = 0
     const validity = 0.00001
 
-    const record = await ipns.create(peerId, cid, sequence, validity)
+    const record = await ipns.create(peerId, contentPath, sequence, validity)
 
     await new Promise(resolve => setTimeout(resolve, 1))
 
@@ -168,7 +167,7 @@ describe('ipns', function () {
     const sequence = 0
     const validity = 1000000
 
-    const createdRecord = await ipns.create(peerId, cid, sequence, validity)
+    const createdRecord = await ipns.create(peerId, contentPath, sequence, validity)
 
     const marshalledData = marshal(createdRecord)
     const unmarshalledData = unmarshal(marshalledData)
@@ -220,7 +219,7 @@ describe('ipns', function () {
     const sequence = 0
     const validity = 1000000
 
-    const record = await ipns.create(peerId, cid, sequence, validity)
+    const record = await ipns.create(peerId, contentPath, sequence, validity)
 
     expect(record.pb).to.deep.include({
       pubKey: peerId.publicKey
@@ -238,7 +237,7 @@ describe('ipns', function () {
     const validity = 1000000
 
     const ed25519 = await createEd25519PeerId()
-    const record = await ipns.create(ed25519, cid, sequence, validity)
+    const record = await ipns.create(ed25519, contentPath, sequence, validity)
 
     expect(record.pb).to.not.have.property('pubKey') // ed25519 keys should not be embedded
   })
@@ -247,7 +246,7 @@ describe('ipns', function () {
     const sequence = 0
     const validity = 1000000
 
-    const record = await ipns.create(peerId, cid, sequence, validity)
+    const record = await ipns.create(peerId, contentPath, sequence, validity)
     delete record.pb.pubKey
 
     const marshalledData = marshal(record)
@@ -260,7 +259,7 @@ describe('ipns', function () {
     const sequence = 0
     const validity = 1000000
 
-    const record = await ipns.create(peerId, cid, sequence, validity)
+    const record = await ipns.create(peerId, contentPath, sequence, validity)
 
     const publicKey = await extractPublicKey(peerId, record)
     expect(publicKey).to.deep.include({

test/selector.spec.ts

@@ -3,7 +3,6 @@
 import { generateKeyPair } from '@libp2p/crypto/keys'
 import { peerIdFromKeys } from '@libp2p/peer-id'
 import { expect } from 'aegir/chai'
-import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
 import * as ipns from '../src/index.js'
 import { ipnsSelector } from '../src/selector.js'
 import { marshal, peerIdToRoutingKey } from '../src/utils.js'
@@ -12,7 +11,7 @@ import type { PeerId } from '@libp2p/interface-peer-id'
 describe('selector', function () {
   this.timeout(20 * 1000)
 
-  const cid = uint8ArrayFromString('QmWEekX7EZLUd9VXRNMRXW3LXe4F6x7mB8oPxY5XLptrBq')
+  const contentPath = '/ipfs/bafkqae3imvwgy3zamzzg63janjzs22lqnzzqu'
   let peerId: PeerId
 
   before(async () => {
@@ -24,8 +23,8 @@ describe('selector', function () {
     const sequence = 0
     const lifetime = 1000000
 
-    const record = await ipns.create(peerId, cid, sequence, lifetime)
-    const newRecord = await ipns.create(peerId, cid, (sequence + 1), lifetime)
+    const record = await ipns.create(peerId, contentPath, sequence, lifetime)
+    const newRecord = await ipns.create(peerId, contentPath, (sequence + 1), lifetime)
 
     const marshalledData = marshal(record)
     const marshalledNewData = marshal(newRecord)
@@ -43,8 +42,8 @@ describe('selector', function () {
     const sequence = 0
     const lifetime = 1000000
 
-    const record = await ipns.create(peerId, cid, sequence, lifetime)
-    const newRecord = await ipns.create(peerId, cid, sequence, (lifetime + 1))
+    const record = await ipns.create(peerId, contentPath, sequence, lifetime)
+    const newRecord = await ipns.create(peerId, contentPath, sequence, (lifetime + 1))
 
     const marshalledData = marshal(record)
     const marshalledNewData = marshal(newRecord)
@@ -62,9 +61,9 @@ describe('selector', function () {
     const sequence = 0
     const lifetime = 1000000
 
-    const record = await ipns.create(peerId, cid, sequence, lifetime)
+    const record = await ipns.create(peerId, contentPath, sequence, lifetime)
 
-    const newRecord = await ipns.create(peerId, cid, sequence + 1, lifetime)
+    const newRecord = await ipns.create(peerId, contentPath, sequence + 1, lifetime)
     delete newRecord.pb.signatureV2
 
     const marshalledData = marshal(record)

test/validator.spec.ts

@@ -16,7 +16,7 @@ import type { PeerId } from '@libp2p/interface-peer-id'
 describe('validator', function () {
   this.timeout(20 * 1000)
 
-  const cid = uint8ArrayFromString('QmWEekX7EZLUd9VXRNMRXW3LXe4F6x7mB8oPxY5XLptrBq')
+  const contentPath = '/ipfs/bafkqae3imvwgy3zamzzg63janjzs22lqnzzqu'
   let peerId1: PeerId
   let peerId2: PeerId
 
@@ -32,7 +32,7 @@ describe('validator', function () {
     const sequence = 0
     const validity = 1000000
 
-    const record = await ipns.create(peerId1, cid, sequence, validity, { v1Compatible: false })
+    const record = await ipns.create(peerId1, contentPath, sequence, validity, { v1Compatible: false })
     const marshalledData = marshal(record)
 
     const keyBytes = base58btc.decode(`z${peerId1.toString()}`)
@@ -45,7 +45,7 @@ describe('validator', function () {
     const sequence = 0
     const validity = 1000000
 
-    const record = await ipns.create(peerId1, cid, sequence, validity, { v1Compatible: true })
+    const record = await ipns.create(peerId1, contentPath, sequence, validity, { v1Compatible: true })
     const marshalledData = marshal(record)
 
     const keyBytes = base58btc.decode(`z${peerId1.toString()}`)
@@ -58,7 +58,7 @@ describe('validator', function () {
     const sequence = 0
     const validity = 1000000
 
-    const record = await ipns.create(peerId1, cid, sequence, validity)
+    const record = await ipns.create(peerId1, contentPath, sequence, validity)
 
     // corrupt the record by changing the value to random bytes
     record.pb.value = randomBytes(record.pb.value?.length ?? 0)
@@ -73,7 +73,7 @@ describe('validator', function () {
     const sequence = 0
     const validity = 1000000
 
-    const record = await ipns.create(peerId1, cid, sequence, validity)
+    const record = await ipns.create(peerId1, contentPath, sequence, validity)
     const marshalledData = marshal(record)
 
     const key = peerIdToRoutingKey(peerId2)
@@ -85,7 +85,7 @@ describe('validator', function () {
     const sequence = 0
     const validity = 1000000
 
-    const record = await ipns.create(peerId1, cid, sequence, validity)
+    const record = await ipns.create(peerId1, contentPath, sequence, validity)
     record.pb.pubKey = peerId2.publicKey
     const marshalledData = marshal(record)