feat: add deploy contract command #242

PainterPuppets · 2023-04-19T00:35:40Z

add deploy contract command

deploy contract workflow:

1. kuai contract new --name [contract-name]

1. kuai contract build --release

1. kuai contract deploy --name [contract-name] --from [0x.....] --signer ckb-cli

Tips: How to deploy contract to other network

kuai contract deploy --name [contract-name] --from [0x.....] --network [networkname]
or set network to .env file

Tips: add more network config

Kuai currently has three default settings for networks, testnet / mainnet / devnet, and users can also add custom network

edit kuai.config.js of project and add network tor networks field

networks: {
    [networkname: string]: {
        rpcUrl: string
        prefix: string
        scripts?: Record<string, ScriptConfig>
    }
}

packages/core/package.json

packages/core/src/builtin-tasks/contract.ts

packages/core/src/type/runtime.ts

Daryl-L · 2023-04-24T06:49:33Z

packages/core/src/builtin-tasks/contract.ts

+    paramTypes.string,
+    true,
+  )
+  .setAction(async ({ name, chain, fee, env, migrate, ...args }: DeployArgs, { config, run }) => {


How about extracting the code of deployment so that we can use it to deploy the infra scripts?

https://github.com/ckb-js/kuai/pull/242/files#diff-5cc22f628d3f35959679ab626647dec8f2027fad3513e367efb42735d69c50cbR66-R71

Keith-CY · 2023-04-26T03:16:17Z

How is it going

PainterPuppets · 2023-05-04T07:38:05Z

The contract module of kuai needs a way to manage and organize, and some parts of the current contract management by capsule do not meet the needs

For example:
- capsule has its own directory structures, which can cause some confusion when using kuai
- deploy contracts by capsule can only be signed by ckb-cli, which can be a strange process
- It is not possible to deploy multiple contracts in a single transaction

So kuai needs to deploy contract code through lumos in order to meet the flexible deploy methods, which will make capsule's ability to organize contracts invalid, so kuai itself needs a way to organize contracts

For this reason, the following three structures are defined, where the ContractManager is used to manage contract information and some configuration. The Contract is the entity for individual contract information, and KuaiContractMigration is generated after each deployment to track the deployment

export interface ContractManager {
	contracts: KuaiContract[]

	newContract: (name: string, template?: 'rust' | 'c' | 'c-sharedlib')
	build: (name: string) => void
	createDeployTx: (name: string, deployer: Address) => Promise<Transaction>
	createUpgradeTx: (name: string, deployer: Address) => Promise<Transaction>
	commitTx: (name: string, witnesses: string[]) => Promise<Hash>
}

interface KuaiContract {
	name: string
	templateType: string
	srcPath: string
	binPath: string
	deployType: 'data' | 'typeId'
	migrations: KuaiContractMigration[]
}

interface KuaiContractMigration {
	chain: string
	txHash: Hash
	index: number
	dataHash: Hash
	typeId: Hash
}

Specific implementation details:
When call newContract, use capsule to generate the code by template
When call build, use capsule to build the contract file (perhaps in the future can support direct build)

deploy process:
kuai-cli calls createDeployTx of the ContractManager to generate the tx, which is then signed by a user-selected signature method (e.g. ckb-cli / metamask / other...)
kuai-cli calls the ContractManager's commitTx to commit the tx to the chain

Keith-CY · 2023-05-04T08:32:48Z

The contract module of kuai needs a way to manage and organize, and some parts of the current contract management by capsule do not meet the needs

For example: - capsule has its own directory structures, which can cause some confusion when using kuai - deploy contracts by capsule can only be signed by ckb-cli, which can be a strange process - It is not possible to deploy multiple contracts in a single transaction

So kuai needs to deploy contract code through lumos in order to meet the flexible deploy methods, which will make capsule's ability to organize contracts invalid, so kuai itself needs a way to organize contracts

For this reason, the following three structures are defined, where the ContractManager is used to manage contract information and some configuration. The Contract is the entity for individual contract information, and KuaiContractMigration is generated after each deployment to track the deployment
export interface ContractManager {
	contracts: KuaiContract[]

	newContract: (name: string, template?: 'rust' | 'c' | 'c-sharedlib')
	build: (name: string) => void
	createDeployTx: (name: string, deployer: Address) => Promise<Transaction>
	createUpgradeTx: (name: string, deployer: Address) => Promise<Transaction>
	commitTx: (name: string, witnesses: string[]) => Promise<Hash>
}

interface KuaiContract {
	name: string
	templateType: string
	srcPath: string
	binPath: string
	deployType: 'data' | 'typeId'
	migrations: KuaiContractMigration[]
}

interface KuaiContractMigration {
	chain: string
	txHash: Hash
	index: number
	dataHash: Hash
	typeId: Hash
}
Specific implementation details: When call newContract, use capsule to generate the code by template When call build, use capsule to build the contract file (perhaps in the future can support direct build)

deploy process: kuai-cli calls createDeployTx of the ContractManager to generate the tx, which is then signed by a user-selected signature method (e.g. ckb-cli / metamask / other...) kuai-cli calls the ContractManager's commitTx to commit the tx to the chain

How about accepting a deployer config instead of deployer in createDeployTx and updateDeployer so it's easy to extend to deploy/update contracts with multisig

Ref: #233

yanguoyu · 2023-05-05T02:40:47Z

kuai-cli calls createDeployTx of the ContractManager to generate the tx, which is then signed by a user-selected signature method (e.g. ckb-cli / metamask / other...)

I think we can support signed by kuai, then developers will not need to know more tools.

Keith-CY · 2023-05-05T02:43:45Z

kuai-cli calls createDeployTx of the ContractManager to generate the tx, which is then signed by a user-selected signature method (e.g. ckb-cli / metamask / other...)

I think we can support signed by kuai, then developers will not need to know more tools.

Upvote, only kuai-cli should be exposed to reduce confusion.

PainterPuppets · 2023-05-05T09:45:26Z

kuai-cli calls createDeployTx of the ContractManager to generate the tx, which is then signed by a user-selected signature method (e.g. ckb-cli / metamask / other...)

I think we can support signed by kuai, then developers will not need to know more tools.

Does support for signature by "kuai" mean wrapping "ckb-cli" or using the keystore directly?

Keith-CY · 2023-05-05T10:24:16Z

kuai-cli calls createDeployTx of the ContractManager to generate the tx, which is then signed by a user-selected signature method (e.g. ckb-cli / metamask / other...)

I think we can support signed by kuai, then developers will not need to know more tools.

Does support for signature by "kuai" mean wrapping "ckb-cli" or using the keystore directly?

It's about the detail of implementation, but ckb-cli requires private key on the disk, which is not recommended.

Keith-CY · 2023-05-08T05:43:26Z

How is it going @PainterPuppets

PainterPuppets · 2023-05-08T08:36:00Z

Have implemented the ContractManager part, is doing the deployment of the signature part, because the keystore built into the kuai spend more time, so are packing ckb-cli signature part, is expected to be completed and submit tomorrow

@Keith-CY

Keith-CY · 2023-05-08T09:33:36Z

Have implemented the ContractManager part, is doing the deployment of the signature part, because the keystore built into the kuai spend more time, so are packing ckb-cli signature part, is expected to be completed and submit tomorrow

@Keith-CY

Looking forward to it

Keith-CY · 2023-05-09T07:57:32Z

How is it going

Keith-CY · 2023-05-10T02:52:03Z

Please update the usage in the PR message and I'll request some reviews from outside teams that may use kuai to deploy contracts.

PainterPuppets · 2023-05-10T04:05:29Z

Please update the usage in the PR message and I'll request some reviews from outside teams that may use kuai to deploy contracts.

Updated, only the ckb-cli signature method is supported for now, but the extension point is left, I don't know what the outside teams is using for the signature, I can go add it

Keith-CY · 2023-05-10T05:47:55Z

Please update the usage in the PR message and I'll request some reviews from outside teams that may use kuai to deploy contracts.

Updated, only the ckb-cli signature method is supported for now, but the extension point is left, I don't know what the outside teams is using for the signature, I can go add it

Should kuai's user keep their private key on the disk to sign the transaction with ckb-cli?

If so, signing a transaction with lumos should be considered, and the private key should be decrypted from a keystore file instead of reading a private key file

Keith-CY · 2023-05-10T05:50:30Z

Please update the usage in the PR message and I'll request some reviews from outside teams that may use kuai to deploy contracts.

Updated, only the ckb-cli signature method is supported for now, but the extension point is left, I don't know what the outside teams is using for the signature, I can go add it

Should kuai's user keep their private key on the disk to sign the transaction with ckb-cli?

If so, signing a transaction with lumos should be considered, and the private key should be decrypted from a keystore file instead of reading a private key file

But it could be treated as a low-priority one, signing a transaction with secp256k1_blake160_multisig_all is more desired

PainterPuppets · 2023-05-10T05:51:21Z

Please update the usage in the PR message and I'll request some reviews from outside teams that may use kuai to deploy contracts.

Updated, only the ckb-cli signature method is supported for now, but the extension point is left, I don't know what the outside teams is using for the signature, I can go add it

Should kuai's user keep their private key on the disk to sign the transaction with ckb-cli?

No, if sign with ckb-cli, need to import account in ckb-cli, but this part is the logic of ckb-cli, after that it should be possible to extend more signature methods, like metamask / Ledger / other...

Keith-CY · 2023-05-10T05:52:39Z

Please update the usage in the PR message and I'll request some reviews from outside teams that may use kuai to deploy contracts.

Updated, only the ckb-cli signature method is supported for now, but the extension point is left, I don't know what the outside teams is using for the signature, I can go add it

Should kuai's user keep their private key on the disk to sign the transaction with ckb-cli?

No, if sign with ckb-cli, need to import account in ckb-cli, but this part is the logic of ckb-cli, after that it should be possible to extend more signature methods, like metamask / Ledger / other...

I see, so kuai doesn't care about where the private key in ckb-cli is from, it's reasonable

PainterPuppets · 2023-05-10T05:55:13Z

If so, signing a transaction with lumos should be considered, and the private key should be decrypted from a keystore file instead of reading a private key file

I thought ahead about the multisg implementation, the specific logic part does not conflict with multisig, at the cli level it will probably look like this

kuai contract deploy --name [contract-name] --address [multisig_1] --address [multisig_2] --address [multisig_3] --network [networkname]

packages/core/package.json

packages/core/src/ckbcli.ts

yanguoyu · 2023-05-11T07:21:29Z

packages/core/src/util/chain.ts

The tx information in block 0 is stable, can we use const variables to define this information?

packages/core/src/builtin-tasks/contract.ts

packages/core/src/constants.ts

packages/core/src/errors-list.ts

packages/core/src/contract.ts

Keith-CY · 2023-05-11T08:08:56Z

packages/core/src/util/chain.ts

+import { RPC, config, utils } from '@ckb-lumos/lumos'
+
+// Special cells in genesis transactions: (transaction-index, output-index)
+const SpecialCellLocation: {


Better to add a reference of this locations

I'm not quite sure where this reference can be found, these magic location is what I see in the source code of ckb-cli

Please refer to the code of ckb-cil, and I'll open an issue in ckb-cli repo for detailed info

https://github.com/nervosnetwork/ckb-sdk-rust/blob/0d6cbb38f59d6bf21982157874c17a1e71b83c81/src/constants.rs#L20-L24

My bad, I didn't notice the comment above, which clearly implies the definition of [number, number] is [transaction-index, output-index]

Among them, SIGNHASH_GROUP, MULTISIG_GROUP, DAO can be found at https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0024-ckb-genesis-script-list/0024-ckb-genesis-script-list.md
SIGHASH, MULTISIG are not used normally. I'm not sure if these two will be used in our project.

Besides, we can use labeled tuple for readability

Ref: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-0.html#labeled-tuple-elements

Keith-CY · 2023-05-11T08:09:46Z

packages/core/src/util/chain.ts

+      ...generateGenesisScriptConfig(...SpecialCellLocation['SIGHASH_GROUP']),
+      CODE_HASH: generateGenesisScriptConfig(...SpecialCellLocation['SIGHASH']).CODE_HASH,
+      DEP_TYPE: 'depGroup',
+      SHORT_ID: 0,


What does SHORT_ID mean here?

SHORT_ID is required for lumos to parse short address

SHORT_ID is required for lumos to parse short address

I think it can be removed if it's not mandatory in lumos because short address is deprecated, and we should guide users not to use it.

codecov-commenter · 2023-05-15T23:18:57Z

Codecov Report

❗ No coverage uploaded for pull request base (develop@01ec626). Click here to learn what that means.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             develop     #242   +/-   ##
==========================================
  Coverage           ?   68.59%           
==========================================
  Files              ?       84           
  Lines              ?     2305           
  Branches           ?      515           
==========================================
  Hits               ?     1581           
  Misses             ?      657           
  Partials           ?       67

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

feat: kuai contract support multisig deploy

Keith-CY · 2023-05-16T02:55:34Z

I see feat: kuai contract support multisig deploy has been merged, and an example of 0/1 multisig tx was demonstrated in that PR.

My question is how to share the partially signed transaction via kuai, e.g. the contract should be deployed by 2/3 multisig, how should the 2 users to deploy the contract.

And the example could be appended in this PR because the PR of feat: kuai contract support multisig deploy will be inconspicuous when it's one commit of this PR

Keith-CY · 2023-05-16T03:06:54Z

I see feat: kuai contract support multisig deploy has been merged, and an example of 0/1 multisig tx was demonstrated in that PR.

My question is how to share the partially signed transaction via kuai, e.g. the contract should be deployed by 2/3 multisig, how should the 2 users to deploy the contract.

And the example could be appended in this PR because the PR of feat: kuai contract support multisig deploy will be inconspicuous when it's one commit of this PR

This feature is required by other features(deploy contract on devnet, complete workflow of building a dapp) so let's merge it first, other details could be added later

PainterPuppets requested review from Daryl-L, Keith-CY, yanguoyu and zhengjianhui April 19, 2023 00:35

PainterPuppets force-pushed the add_deploy_command branch 2 times, most recently from 23b6c8a to 57f6cdf Compare April 19, 2023 00:40

Keith-CY reviewed Apr 21, 2023

View reviewed changes

yanguoyu reviewed Apr 23, 2023

View reviewed changes

packages/core/src/builtin-tasks/contract.ts Outdated Show resolved Hide resolved

packages/core/src/type/runtime.ts Outdated Show resolved Hide resolved

packages/core/src/type/runtime.ts Outdated Show resolved Hide resolved

Daryl-L reviewed Apr 24, 2023

View reviewed changes

packages/core/src/type/runtime.ts Outdated Show resolved Hide resolved

Daryl-L reviewed Apr 24, 2023

View reviewed changes

Keith-CY mentioned this pull request Apr 26, 2023

Add contract module in kuai project #93

Closed

Keith-CY assigned PainterPuppets Apr 26, 2023

PainterPuppets force-pushed the add_deploy_command branch from 57f6cdf to 9835de2 Compare May 9, 2023 20:50

PainterPuppets requested review from Daryl-L, Keith-CY and yanguoyu May 9, 2023 20:50

feat: add deploy contract command

8247db5

PainterPuppets force-pushed the add_deploy_command branch 2 times, most recently from 4b0219b to 1d45bd4 Compare May 9, 2023 21:44

feat: add networks config & optimize contract deployment

5fdff6e

yanguoyu reviewed May 11, 2023

View reviewed changes

Keith-CY reviewed May 11, 2023

View reviewed changes

PainterPuppets force-pushed the add_deploy_command branch from 1d45bd4 to 7122237 Compare May 12, 2023 09:14

PainterPuppets requested review from Keith-CY and yanguoyu May 12, 2023 09:20

chore: optimize code

2b46199

PainterPuppets force-pushed the add_deploy_command branch from 7122237 to 2b46199 Compare May 15, 2023 23:07

feat: kuai contract support multisig deploy

da10bc8

yanguoyu approved these changes May 15, 2023

View reviewed changes

Merge pull request #264 from ckb-js/contract_support_multisig_deploy

451af3b

feat: kuai contract support multisig deploy

Keith-CY merged commit 9b1bf62 into develop May 16, 2023

Keith-CY deleted the add_deploy_command branch May 16, 2023 03:07

Keith-CY mentioned this pull request May 24, 2023

Deploy precompiled binary #231

Closed

This was referenced Jun 6, 2023

feat(mvp): support contract #294

Merged

Tutorial to build a profile DApp with Kuai #306

Closed

This was referenced Jul 21, 2023

Update versions and changelogs for 0.1.1-alpha #385

Closed

Update versions and changelogs for 0.0.1-alpha #386

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add deploy contract command #242

feat: add deploy contract command #242

PainterPuppets commented Apr 19, 2023 •

edited

Loading

Daryl-L Apr 24, 2023

PainterPuppets May 9, 2023

Keith-CY commented Apr 26, 2023

PainterPuppets commented May 4, 2023 •

edited

Loading

Keith-CY commented May 4, 2023

yanguoyu commented May 5, 2023

Keith-CY commented May 5, 2023

PainterPuppets commented May 5, 2023

Keith-CY commented May 5, 2023

Keith-CY commented May 8, 2023

PainterPuppets commented May 8, 2023

Keith-CY commented May 8, 2023

Keith-CY commented May 9, 2023

Keith-CY commented May 10, 2023

PainterPuppets commented May 10, 2023

Keith-CY commented May 10, 2023 •

edited

Loading

Keith-CY commented May 10, 2023

PainterPuppets commented May 10, 2023

Keith-CY commented May 10, 2023

PainterPuppets commented May 10, 2023

yanguoyu May 11, 2023

Keith-CY May 11, 2023

PainterPuppets May 11, 2023

Keith-CY May 11, 2023

PainterPuppets May 12, 2023

Keith-CY May 12, 2023

Keith-CY May 11, 2023

PainterPuppets May 11, 2023

Keith-CY May 11, 2023

codecov-commenter commented May 15, 2023 •

edited

Loading

Keith-CY commented May 16, 2023

Keith-CY commented May 16, 2023

feat: add deploy contract command #242

feat: add deploy contract command #242

Conversation

PainterPuppets commented Apr 19, 2023 • edited Loading

deploy contract workflow:

Tips: How to deploy contract to other network

Tips: add more network config

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Keith-CY commented Apr 26, 2023

PainterPuppets commented May 4, 2023 • edited Loading

Keith-CY commented May 4, 2023

yanguoyu commented May 5, 2023

Keith-CY commented May 5, 2023

PainterPuppets commented May 5, 2023

Keith-CY commented May 5, 2023

Keith-CY commented May 8, 2023

PainterPuppets commented May 8, 2023

Keith-CY commented May 8, 2023

Keith-CY commented May 9, 2023

Keith-CY commented May 10, 2023

PainterPuppets commented May 10, 2023

Keith-CY commented May 10, 2023 • edited Loading

Keith-CY commented May 10, 2023

PainterPuppets commented May 10, 2023

Keith-CY commented May 10, 2023

PainterPuppets commented May 10, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-commenter commented May 15, 2023 • edited Loading

Codecov Report

Keith-CY commented May 16, 2023

Keith-CY commented May 16, 2023

PainterPuppets commented Apr 19, 2023 •

edited

Loading

PainterPuppets commented May 4, 2023 •

edited

Loading

Keith-CY commented May 10, 2023 •

edited

Loading

codecov-commenter commented May 15, 2023 •

edited

Loading