Merge branch 'main' into feature-ci-build

Author: bafu

.yarnrc.yml

@@ -0,0 +1,5 @@
+nodeLinker: node-modules
+
+plugins:
+  - path: .yarn/plugins/@yarnpkg/plugin-version.cjs
+    spec: "@yarnpkg/plugin-version"

CHANGELOG.md

@@ -0,0 +1,58 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+To check the difference between the last releaes and the latest dev status, click the link above.
+
+## [1.6.0] - 2023-10-03
+
+### Added
+
+1. Add initial registration action for IOTA.
+
+## [1.5.0] - 2023-06-15
+
+### Changed
+
+1. [PR26](https://github.com/numbersprotocol/nit/pull/26): Remove default license from Asset Tree
+1. [PR27](https://github.com/numbersprotocol/nit/pull/27): Remove default empty abstract without input
+
+## [1.4.0] - 2023-05-02
+
+### Added
+
+1. Add [Action Names](https://docs.numbersprotocol.io/introduction/numbers-protocol/defining-web3-assets/commit#actions)
+
+### Changed
+
+1. Add IPFS abstract layer to support multiple IPFS backends
+
+## [1.3.0] - 2023-02-14
+
+### Added
+
+1. Add action action-mint-erc721-nft-jade
+2. Add Numbers networks into config template
+2. Add ESLint
+
+### Changed
+
+1. Remove not-yet-supported networks from the network dictionary
+
+## [1.2.9] - 2023-01-28
+
+### Fixed
+
+1. Change default network in registration action from Avalanche to Jade
+
+[unreleased]: https://github.com/numbersprotocol/capture-lite/compare/1.6.0...HEAD
+[1.6.0]: https://github.com/numbersprotocol/capture-lite/compare/1.5.0...1.6.0
+[1.5.0]: https://github.com/numbersprotocol/capture-lite/compare/1.4.0...1.5.0
+[1.4.0]: https://github.com/numbersprotocol/capture-lite/compare/1.3.0...1.4.0
+[1.3.0]: https://github.com/numbersprotocol/capture-lite/compare/1.2.9...1.3.0
+[1.2.9]: https://github.com/numbersprotocol/capture-lite/releases/tag/1.2.9

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@numbersprotocol/nit",
-  "version": "1.2.10",
+  "version": "1.6.0",
   "description": "git for web3 digital asset",
   "main": "lib/nit.js",
   "repository": "https://github.com/numbersprotocol/nit",
@@ -27,8 +27,8 @@
     "dev-global-uninstall": "yarn global remove @numbersprotocol/nit",
     "dev-install": "yarn run build && yarn add file:$PWD",
     "dev-uninstall": "yarn remove @numbersprotocol/nit && yarn run clean",
-    "test": "env TS_NODE_COMPILER_OPTIONS='{\"module\": \"commonjs\" }' mocha -r ts-node/register 'tests/**/*.ts'",
-    "test-single": "env TS_NODE_COMPILER_OPTIONS='{\"module\": \"commonjs\" }' mocha -r ts-node/register"
+    "tests": "mocha -r ts-node/register tests/**/*.ts",
+    "test": "mocha -r ts-node/register"
   },
   "bin": "bin/nit.js",
   "devDependencies": {
@@ -41,7 +41,7 @@
     "@types/command-line-usage": "^5.0.2",
     "@types/crypto-js": "^4.1.1",
     "@types/mocha": "^9.1.0",
-    "@types/node": "^18.13.0",
+    "@types/node": "^18.16.1",
     "@typescript-eslint/eslint-plugin": "^5.51.0",
     "@typescript-eslint/parser": "^5.51.0",
     "chai": "^4.3.6",
@@ -59,6 +59,6 @@
     "/bin"
   ],
   "volta": {
-    "node": "16.19.0"
+    "node": "18.16.0"
   }
 }

schema/dbml.md

@@ -1,13 +1,13 @@
-```
+```dbml
 Project IntegrityRecord {
   Note: '''
   description: Numbers Protocol Integrity Record spec
-  version: 4.0.0
-  date: 2022-08-25
+  version: 4.3.0
+  date: 2023-05-11
   colors:
     - purple: on blockchain (updatable)
     - blue: files on IPFS (updatable)
-    - yello: json
+    - yellow: json
     - red: signature related
     - grey: centralized server or DID
   '''
@@ -19,13 +19,13 @@ Table commit [headercolor: #8e44ad] {
   assetTreeCid cid [note: 'CID of the asset Tree file']
   assetTreeSha256 sha256 [note: 'sha256sum of the asset Tree file']
   assetTreeSignature signature [note: 'EIP-191 signature signed by author.']
-  author address [note: 'Who creates the commit.']
-  committer address [note: 'Who registers the commit.']
-  action cid [note: 'CID of the network action performed for the asset file.']
-  actionResultUri str [note: 'Result uri of this action']
+  committer address [note: 'Who registers the commit']
+  author address [note: 'Who write the commit']
+  action cid [note: 'CID of the action profile describing the action details including actionName.']
+  actionName str [note: 'name of the action, unique string']
+  actionResult str [note: 'Result uri of this action']
   provider cid [note: 'CID of the commit service provider.']
-  abstract str [note: 'Committer can add a short description that summarizes the Integrity Record.']
-  timestampCreated timestamp [note: 'The moment that Integrity Record is created in Unix timestamp']
+  attachment str [note: 'the Nid of the attachment file.']
 
   Note: '''
   1. The goal of Integrity Record is to ensure integrity of the raw asset and its derivatives like metadata and maybe the major asset.
@@ -67,14 +67,22 @@ Table assetTree [headercolor: #3498db] {
   _ none [note: 'placeholder for linking tables']
   assetCid cid [note: 'CID of the asset file (blob)']
   assetSha256 sha256 [note: 'sha256sum of the asset file (blob)']
-  assetCreator address [note: 'Creator\'s wallet address']
-  assetCreatorProfile cid [note: 'Creator of the asset file']
+  encodingFormat str [note: 'The asset\'s type expressed using a MIME format.']
+  assetCreator str [note: 'Creator\'s name']
+  creatorProfile cid [note: 'Creator of the asset file']
+  creatorWallet address [note: 'Creator\'s wallet address']
   assetTimestampCreated timestamp [note: 'Creation time of the asset file']
+  assetLocationCreated str [note: 'Creation location of the asset file']
+  parentAssetCid cid [note: 'Cid of the parent asset']
+  generatedBy str [note: 'AI model used to generate the content']
+  generatedThrough str [note: 'URL of AI service']
+  usedBy str [note: 'URL of the website that uses the asset']
   license license [note: 'license of the asset file']
-  nftRecord cid
+  nftRecord "nftRecord[]" [note: 'List of NFT records']
   integrityCid cid [note: 'CID of the integrity proof']
   abstract str [note: 'description of this asset']
-  encodingFormat str [note: 'The asset\'s type expressed using a MIME format.']
+  custom json [note: 'custom fields']
+
 
   Note: '''
   EIP-191 Verification
@@ -109,7 +117,6 @@ Table nftRecord [headercolor: #3498db] {
   network network [note: 'network of the NFT token']
   contractAddress address
   tokenId str
-  tokenUri str
 }
 
 Table nft [headercolor: #8e44ad] {
@@ -207,10 +214,9 @@ Enum "proofKey" {
 }
 
 Ref: "nftRecord"."tokenId" - "nft"."tokenId"
-Ref: "nftRecord"."tokenUri" - "nft".tokenUri
 Ref: "assetTree"."license" - "license"."_"
 Ref: "assetTree"."integrityCid" - "proofMetadata"."_"
-Ref: "assetTree"."assetCreatorProfile" - "identity"."_"
+Ref: "assetTree"."creatorProfile" - "identity"."_"
 Ref: "assetTree".nftRecord < nftRecord."_" // One asset can link to multiple nft_records
 Ref: "commit"."action" - "action"."_"
 Ref: "commit"."provider" - "identity"."_"

scripts/parseTxNid.ts

@@ -0,0 +1,35 @@
+#!/usr/bin/env ts-node
+
+/*
+Execution: ts-node parseTxNid.ts
+Output: Nid: bafybeiajl3iadbz5phbig6ojxrau22a67lzrba2srdqn2jzy3bpl7oxd6u
+*/
+
+import * as ethers from "ethers";
+
+async function main() {
+  const provider = new ethers.providers.JsonRpcProvider("https://mainnetrpc.num.network");
+  // Tx Sample: https://mainnet.num.network/transaction/0xca942395e9c36b3217422979978838a45891336ca54bb036d6aecd43f0b56187
+  const txHash = "0xca942395e9c36b3217422979978838a45891336ca54bb036d6aecd43f0b56187";
+
+  // parse the transaction with the function signature
+  const abi = [ "function commit(string memory assetCid, string memory commitData) public returns (uint256 blockNumber)" ];
+  const iface = new ethers.utils.Interface(abi);
+
+  const txData = await provider.getTransaction(txHash);
+  // uncomment the following line to see the raw transaction data
+  //console.log(txData);
+
+  const decodedTxData = iface.parseTransaction(txData);
+  // uncomment the following line to see the decoded transaction data
+  //console.log(decodedTxData);
+
+  console.log(`Nid: ${decodedTxData.args[0]}`);
+}
+
+main()
+  .then(() => process.exit(0))
+  .catch((error) => {
+    console.error(error);
+    process.exit(1);
+  });