Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/empty-schools-return.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@ckb-ccc/core": patch
---

fix(core): occupy witness while adding output

6 changes: 6 additions & 0 deletions .changeset/odd-experts-win.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@ckb-ccc/co-build": minor
---

feat(co-build): new CoBuild package

21 changes: 21 additions & 0 deletions packages/co-build/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
node_modules/
misc/

*test.js
*test.ts
*test.d.ts
*test.d.ts.map
*spec.js
*spec.ts
*spec.d.ts
*spec.d.ts.map

tsconfig.json
tsconfig.*.json
eslint.config.mjs
.prettierrc
.prettierignore

tsconfig.tsbuildinfo
tsconfig.*.tsbuildinfo
.github/
15 changes: 15 additions & 0 deletions packages/co-build/.prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
node_modules/

dist/
dist.commonjs/

.npmignore
.prettierrc
tsconfig.json
eslint.config.mjs
prettier.config.*

tsconfig.tsbuildinfo
.github/

CHANGELOG.md
44 changes: 44 additions & 0 deletions packages/co-build/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<p align="center">
<a href="https://app.ckbccc.com/">
<img alt="Logo" src="https://raw.githubusercontent.com/ckb-devrel/ccc/master/assets/logoAndText.svg" style="height: 8rem; max-width: 90%; padding: 0.5rem 0;" />
</a>
</p>

<h1 align="center" style="font-size: 48px;">
@ckb-ccc/co-build
</h1>

<p align="center">
CCC - CKBers' Codebase is a one-stop solution for your CKB JS/TS ecosystem development.
</p>

## Overview

`@ckb-ccc/co-build` provides tools and Molecule codecs to support the CKB Co-build Protocol, a standard for coordinating multi-party signers and complex script operations (such as Spore actions) within a single transaction.

## Quick Example

```typescript
import { ccc } from "@ckb-ccc/core";
import { CoBuild, ScriptInfo } from "@ckb-ccc/co-build";

const coBuild = new CoBuild(
{
codeHash: "0x...",
hashType: "type",
args: "0x...",
},
{
name: "MyScript",
url: "https://example.com",
schema: "MySchema",
messageType: "MyMessageType",
},
);

// Build action
const action = coBuild.buildAction(ccc.bytesFrom("action payload"));

// Append to transaction
const { tx } = await coBuild.appendActions(transaction, action);
```
62 changes: 62 additions & 0 deletions packages/co-build/eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
// @ts-check

import eslint from "@eslint/js";
import eslintPluginPrettierRecommended from "eslint-plugin-prettier/recommended";
import tseslint from "typescript-eslint";

import { dirname } from "path";
import { fileURLToPath } from "url";

export default [
...tseslint.config({
files: ["**/*.ts"],
extends: [
eslint.configs.recommended,
...tseslint.configs.recommendedTypeChecked,
],
rules: {
"@typescript-eslint/no-unused-vars": [
"error",
{
args: "all",
argsIgnorePattern: "^_",
caughtErrors: "all",
caughtErrorsIgnorePattern: "^_",
destructuredArrayIgnorePattern: "^_",
varsIgnorePattern: "^_",
ignoreRestSiblings: true,
},
],
"@typescript-eslint/unbound-method": ["error", { ignoreStatic: true }],
"@typescript-eslint/no-unsafe-member-access": "off",
"@typescript-eslint/require-await": "off",
"@typescript-eslint/only-throw-error": [
"error",
{
allowThrowingAny: true,
allowThrowingUnknown: true,
allowRethrowing: true,
},
],
"@typescript-eslint/prefer-promise-reject-errors": [
"error",
{
allowThrowingAny: true,
allowThrowingUnknown: true,
},
],
"no-empty": "off",
"prefer-const": [
"error",
{ ignoreReadBeforeAssign: true, destructuring: "all" },
],
},
languageOptions: {
parserOptions: {
project: true,
tsconfigRootDir: dirname(fileURLToPath(import.meta.url)),
},
},
}),
eslintPluginPrettierRecommended,
];
3 changes: 3 additions & 0 deletions packages/co-build/misc/basedirs/dist.commonjs/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"type": "commonjs"
}
3 changes: 3 additions & 0 deletions packages/co-build/misc/basedirs/dist/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"type": "module"
}
54 changes: 54 additions & 0 deletions packages/co-build/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
{
"name": "@ckb-ccc/co-build",
"version": "0.0.0",
"description": "CoBuild",
"author": "Hanssen <0@hanssen0.com>",
"license": "MIT",
"private": false,
"homepage": "https://github.com/ckb-devrel/ccc",
"repository": {
"type": "git",
"url": "git://github.com/ckb-devrel/ccc.git"
},
"main": "./dist.commonjs/index.js",
"module": "./dist/index.mjs",
"exports": {
".": {
"import": "./dist/index.mjs",
"require": "./dist.commonjs/index.js"
},
"./barrel": {
"import": "./dist/barrel.mjs",
"require": "./dist.commonjs/barrel.js"
},
"./package.json": "./package.json"
},
"scripts": {
"test": "vitest",
"test:ci": "vitest run",
"build": "tsdown",
"lint": "tsc --noEmit && eslint ./src",
"format": "prettier --write . && eslint --fix ./src"
},
"devDependencies": {
"@eslint/js": "^10.0.1",
"@types/node": "^26.0.0",
"eslint": "^10.5.0",
"eslint-config-prettier": "^10.1.8",
"eslint-plugin-prettier": "^5.5.6",
"prettier": "^3.8.4",
"prettier-plugin-organize-imports": "^4.3.0",
"tsdown": "^0.22.3",
"typescript": "^6.0.3",
"typescript-eslint": "^8.61.1",
"vitest": "^4.1.9"
},
"publishConfig": {
"access": "public"
},
"dependencies": {
"@ckb-ccc/core": "workspace:*"
},
"packageManager": "pnpm@11.8.0",
"types": "./dist.commonjs/index.d.ts"
}
11 changes: 11 additions & 0 deletions packages/co-build/prettier.config.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/**
* @see https://prettier.io/docs/configuration
* @type {import("prettier").Config}
*/
const config = {
singleQuote: false,
trailingComma: "all",
plugins: [require.resolve("prettier-plugin-organize-imports")],
};

module.exports = config;
2 changes: 2 additions & 0 deletions packages/co-build/src/barrel.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export * from "./coBuild.js";
export * from "./codec/index.js";
Loading