[Feature Request] Adding CKBFS contract scripts

[code-monad]

Hello. CKBFS has been released for a while and widely used in Nervape's production line, it's a decentrialized filesystem protocol define natively for Nervos CKB.
The design and proposal can be checked in here: https://talk.nervos.org/t/ckbfs-protocol-a-standard-for-witnesses-based-content-storage-system/

There are currently two active version of this protocol:
v2 is a stable version that also used by other teams like NFTNation; it stores the file chunks postion directly in cell data;
v3 is the edge version, only metadata will be stored in cell data, and all other information will goes into witnesses

This issue is a feature request that ONLY wants to flag ckbfs v2 and v3 cells on explorer;
(But would be great if the user can access to the file directly)
we have an aggregator server implemented at: https://github.com/nervape/ckbfs-server
example resource showcase:

• https://ckbfs.nvap.app/api/v1/ckbfs?uri=ckbfs://56831d51ab469eb7ee6551fd39e65caeff9b35569804a6532cf00f4c6f6e3d6a
• https://test-ckbfs.nvap.app/api/v1/ckbfs?uri=ckbfs://431c9d668c1815d26eb4f7ac6256eb350ab351474daea8d588400146ab228780i0

---

Belows are some detail information about the contract repo, deployment, and related stuffs:

• contract repo: https://github.com/code-monad/ckbfs

• RFC: https://github.com/code-monad/ckbfs/blob/master/RFC.md

• RFC(v3): https://github.com/code-monad/ckbfs/blob/master/RFC.v3.md

• deployments:

  • mainnet:
    • v2:
      • code_hash: 0x31e6376287d223b8c0410d562fb422f04d1d617b2947596a14c3d2efb7218d3a
      • type_id: 0xfd2058c9a0c0183354cf637e25d2707ffa9bb6fa2ba9b29f4ebc6be3e54ad7eb
      • deploy_tx: https://explorer.nervos.org/transaction/0xc9b6698f44c3b80e7e1c48823b2714e432b93f0206ffaf9df885d23267ed2ebc
    • v3:
      • code_hash: 0xb5d13ffe0547c78021c01fe24dce2e959a1ed8edbca3cb93dd2e9f57fb56d695
      • type_id: 0xcc5411e8b70e551d7a3dd806256533cff6bc12118b48dd7b2d5d2292c3651add
      • deploy_tx: https://explorer.nervos.org/transaction/0xc9b6698f44c3b80e7e1c48823b2714e432b93f0206ffaf9df885d23267ed2ebc
  • testnet:
    • v2:
      • code_hash: 0x31e6376287d223b8c0410d562fb422f04d1d617b2947596a14c3d2efb7218d3a
      • type_id: 0x7c6dcab8268201f064dc8676b5eafa60ca2569e5c6209dcbab0eb64a9cb3aaa3
      • deploy_tx: https://explorer.nervos.org/transaction/0x2c8c9ad3134743368b5a79977648f96c5bd0aba187021a72fb624301064d3616
    • v3:
      • code_hash: 0xb5d13ffe0547c78021c01fe24dce2e959a1ed8edbca3cb93dd2e9f57fb56d695
      • type_id: 0xaebf5a7b541da9603c2066a9768d3d18fea2e7f3c1943821611545155fecc671
      • deploy_tx: https://explorer.nervos.org/transaction/0x1488b592b0946589730c906c6d9a46fb82c1181156fc1a4251adce14002a9cfb

[code-monad]

comment again：这个issue主要是为了在explorer中将使用了ckbfs的cell标识出来，就像其他提交了script信息的合约一样； cc @Keith-CY @walker27

[code-monad]

moleculec data inside cell.data:

v3:

array Uint32 [byte; 4];
array Byte32 [byte; 32];
vector Bytes <byte>;

table CKBFSData {
  index: Uint32,
  checksum: Uint32,
  content_type: Bytes,
  filename: Bytes,
}

v2:

array Uint32 [byte; 4];
array Byte32 [byte; 32];
vector Bytes <byte>;
option Uint32Opt (Uint32);
vector Indexes <Uint32>;

table CKBFSData {
  indexes: Indexes,
  checksum: Uint32,
  content_type: Bytes,
  filename: Bytes,
  backlinks: BackLinkVec,
}

table BackLink {
  indexes: Indexes,
  checksum: Uint32,
  tx_hash: Byte32,
}

vector BackLinkVec <BackLink>;

[u2]

Please check, @code-monad

https://testnet.explorer.nervos.org/script/0x31e6376287d223b8c0410d562fb422f04d1d617b2947596a14c3d2efb7218d3a/data1
https://testnet.explorer.nervos.org/script/0xb5d13ffe0547c78021c01fe24dce2e959a1ed8edbca3cb93dd2e9f57fb56d695/data1

https://explorer.nervos.org/script/0x31e6376287d223b8c0410d562fb422f04d1d617b2947596a14c3d2efb7218d3a/data1

[u2]

For mainnet, v2 and v3 have the same tx?
https://explorer.nervos.org/transaction/0xc9b6698f44c3b80e7e1c48823b2714e432b93f0206ffaf9df885d23267ed2ebc
@code-monad

[walker27]

Hi, @code-monad . I'm trying to decode cell data with javascript lib @ckb-ccc/ccc. I have successfully decode v3 and part of v2 data, but some (with backlinks I guess) are failed. can you point out where's the problem?

import { mol } from "@ckb-ccc/ccc"

const v2Parser = (() => {
  const Indexses = mol.vector(mol.Uint32)
  const BackLink = mol.table({
    tx_hash: mol.Bytes,
    index: Indexses,
    checksum: mol.Uint32,
  });
  const CKBFSData = mol.table({
    index: Indexses,
    checksum: mol.Uint32,
    content_type: mol.Bytes,
    filename: mol.Bytes,
    backlinks: mol.vector(BackLink),
  })
  return CKBFSData
})()

// success testnet txHash: 0xdbe3babcfe0792ffe645d172b5278087473ff3490f045bbd63d55cdbf288c46c
// console.log(v2Parser.decode("0x51000000180000002000000024000000320000004d00000001000000010000002614cb020a000000746578742f706c61696e170000004e41303032354e4d4e5641503030303130322e4c4f475304000000"))
// failed testnet txHash: 0xb88a3b4072f2ecfb0a0ec8052ef6d053417e587b31a76c268e2daa4241d43ec7
console.log(v2Parser.decode("0x91000000180000002000000024000000320000004d00000001000000010000007d3e17ef0a000000746578742f706c61696e170000004e41303032354e4d4e5641503030303130312e4c4f475344000000080000003c00000010000000180000001c00000001000000010000002614cb027f52a981dc8f40d7d1a726144f181efbefe36b5076eff3f2bbba4afc7d7913ba"))

[code-monad]

For mainnet, v2 and v3 have the same tx? https://explorer.nervos.org/transaction/0xc9b6698f44c3b80e7e1c48823b2714e432b93f0206ffaf9df885d23267ed2ebc @code-monad

sorry I have paste the wrong tx hash;
v2 contract: 0xc9b6698f44c3b80e7e1c48823b2714e432b93f0206ffaf9df885d23267ed2ebc
v3 contract: 0xd25f2c32f56c28c630d4f91955f1b3c9cd53e26fa0745d540d934e8e3d3c2853

[code-monad]

Hi, @code-monad . I'm trying to decode cell data with javascript lib @ckb-ccc/ccc. I have successfully decode v3 and part of v2 data, but some (with backlinks I guess) are failed. can you point out where's the problem?

import { mol } from "@ckb-ccc/ccc"

const v2Parser = (() => {
const Indexses = mol.vector(mol.Uint32)
const BackLink = mol.table({
tx_hash: mol.Bytes,
index: Indexses,
checksum: mol.Uint32,
});
const CKBFSData = mol.table({
index: Indexses,
checksum: mol.Uint32,
content_type: mol.Bytes,
filename: mol.Bytes,
backlinks: mol.vector(BackLink),
})
return CKBFSData
})()

// success testnet txHash: 0xdbe3babcfe0792ffe645d172b5278087473ff3490f045bbd63d55cdbf288c46c
// console.log(v2Parser.decode("0x51000000180000002000000024000000320000004d00000001000000010000002614cb020a000000746578742f706c61696e170000004e41303032354e4d4e5641503030303130322e4c4f475304000000"))
// failed testnet txHash: 0xb88a3b4072f2ecfb0a0ec8052ef6d053417e587b31a76c268e2daa4241d43ec7
console.log(v2Parser.decode("0x91000000180000002000000024000000320000004d00000001000000010000007d3e17ef0a000000746578742f706c61696e170000004e41303032354e4d4e5641503030303130312e4c4f475344000000080000003c00000010000000180000001c00000001000000010000002614cb027f52a981dc8f40d7d1a726144f181efbefe36b5076eff3f2bbba4afc7d7913ba"))

sorry I can successfully decode it through @ckb-lumos/codec (see: https://github.com/code-monad/ckbfs-api/blob/master/src/utils/molecule.ts), and the decoder server(relays the same code base) seems to work fine: https://test-ckbfs.nvap.app/api/v1/ckbfs?uri=ckbfs://7a12852cbbdaca214e688a0d30f81297f89d9455727714215ab96ea5d9ca1c6e

[u2]

For mainnet, v2 and v3 have the same tx? https://explorer.nervos.org/transaction/0xc9b6698f44c3b80e7e1c48823b2714e432b93f0206ffaf9df885d23267ed2ebc @code-monad

sorry I have paste the wrong tx hash; v2 contract: 0xc9b6698f44c3b80e7e1c48823b2714e432b93f0206ffaf9df885d23267ed2ebc v3 contract: 0xd25f2c32f56c28c630d4f91955f1b3c9cd53e26fa0745d540d934e8e3d3c2853

Updated contract info. Please check it. @code-monad

https://explorer.nervos.org/en/script/0x31e6376287d223b8c0410d562fb422f04d1d617b2947596a14c3d2efb7218d3a/data1

https://explorer.nervos.org/en/script/0xb5d13ffe0547c78021c01fe24dce2e959a1ed8edbca3cb93dd2e9f57fb56d695/data1?page=2&size=10&restrict=false

[code-monad]

For mainnet, v2 and v3 have the same tx? https://explorer.nervos.org/transaction/0xc9b6698f44c3b80e7e1c48823b2714e432b93f0206ffaf9df885d23267ed2ebc @code-monad

sorry I have paste the wrong tx hash; v2 contract: 0xc9b6698f44c3b80e7e1c48823b2714e432b93f0206ffaf9df885d23267ed2ebc v3 contract: 0xd25f2c32f56c28c630d4f91955f1b3c9cd53e26fa0745d540d934e8e3d3c2853

Updated contract info. Please check it. @code-monad

https://explorer.nervos.org/en/script/0x31e6376287d223b8c0410d562fb422f04d1d617b2947596a14c3d2efb7218d3a/data1

https://explorer.nervos.org/en/script/0xb5d13ffe0547c78021c01fe24dce2e959a1ed8edbca3cb93dd2e9f57fb56d695/data1?page=2&size=10&restrict=false

LGTM

[code-monad]

Another problem:
The cell still marked as CKB Capacity

scripts like spore will have a different marker on the tx detail

is it possible to mark those cells as text "CKBFS (v2/v3)" instead normal capacity cell on the details? like how we treat general udt scripts

[u2]

Another problem: The cell still marked as CKB Capacity

scripts like spore will have a different marker on the tx detail is it possible to mark those cells as text "CKBFS (v2/v3)" instead normal capacity cell on the details? like how we treat general udt scripts

This contract is not an XUDT, so its display differs from XUDT contracts.
We may implement this in the new explorer, depending on our development schedule.

[code-monad]

Here's another thing;
https://github.com/nervosnetwork/ckb-explorer-frontend/blob/develop/package.json#L11
we are using an already archived package for dob rendering; it is okay, but it won't accepts any updates for example my pr to support ckbfs preview rendering when using ckbfs:// uri instead of btcfs:// in dob traits;

here we have a forked version, adding supports for ckbfs rendering just follow other links like btcfs://, ipfs:// etc...
here's the diff of the implementation you can check: https://github.com/nervina-labs/dob-render-sdk/compare/main...nervape:dob-render-sdk:main?diff=unified&w#diff-7d8afcc14fdb54eb87467ec4eefbd36f77230f7ff04de3875ef12cd5895c6902L8

So my recommendation is:

Use our patched version of this package"@nervina-labs/dob-render": "^0.2.5"
Change it into "@nervape/dob-render": "^0.2.7"

so that you can render ckbfs images configured in dob without any modification of your existing codes

@u2 @walker27

here's our npm publish page: https://www.npmjs.com/package/@nervape/dob-render

[code-monad]

please check if "@nervape/dob-render": "^0.2.7" works;

0.2.6 just forgot to build dist before package release