feat: ownership provider to work with Lumos

[homura]

• injectCapacity
• payFee
• collector
• signTransaction

update(2023-03-20):

• we should change constructor from {ckb: InjectedCkb} to {ckb: InjectedCkb , rpcUrl: string } since the ScriptConfig is required for the Provider

  nexus/packages/extension-chrome/src/services/ownership/backend/backendUtils.ts

  Lines 66 to 87 in abadb89

  	async function loadSecp256k1ScriptDep(payload: { nodeUrl: string }): Promise<ScriptConfig> {
  	const genesisBlock = await createRpcClient(payload.nodeUrl).request<RpcType.Block>('get_block_by_number', ['0x0']);
  	if (!genesisBlock) throw new Error("can't load genesis block");
  	const secp256k1DepTxHash = genesisBlock.transactions[1].hash;
  	asserts.asserts(secp256k1DepTxHash, "can't load secp256k1 transaction");
  	const rawTypeScript = genesisBlock.transactions[0].outputs[1].type;
  	asserts.asserts(rawTypeScript, "can't load secp256k1 type script");
  	const typeScript: Script = {
  	codeHash: rawTypeScript.code_hash,
  	hashType: rawTypeScript.hash_type,
  	args: rawTypeScript.args,
  	};
  	const secp256k1TypeHash = utils.computeScriptHash(typeScript);
  	return {
  	HASH_TYPE: 'type',
  	CODE_HASH: secp256k1TypeHash,
  	INDEX: '0x0',
  	TX_HASH: secp256k1DepTxHash,
  	DEP_TYPE: 'depGroup',
  	};
  	}

🐤 Download canary assets:

nexus--canary.127.4635976068.zip

[codecov]

Codecov Report

Merging #127 (a0ec159) into main (5543361) will decrease coverage by 1.05%.
The diff coverage is 81.25%.

@@            Coverage Diff             @@
##             main     #127      +/-   ##
==========================================
- Coverage   87.25%   86.20%   -1.05%     
==========================================
  Files          48       43       -5     
  Lines         816      870      +54     
  Branches       97      113      +16     
==========================================
+ Hits          712      750      +38     
+ Misses         21       20       -1     
- Partials       83      100      +17     

Impacted Files	Coverage Δ
...s/ownership-providers/src/FullOwnershipProvider.ts	81.05% <81.05%> (ø)
packages/ownership-providers/src/index.ts	100.00% <100.00%> (ø)

... and 14 files with indirect coverage changes

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

[IronLu233]

How to get the provider instance? it seems to be:

const provider = new FullOwnershipProvider(globalThis.ckb)

[homura]

new FullOwnershipProvider({ ckb: globalThis.ckb })

we can check out from FullOwnershipProvider.ts

[IronLu233]

An idea: a test case can be based on this example.

[homura]

indeed, this example is suitable as a case for integration testing, but I think it may be less suitable as a unit test case

[IronLu233]

I want to reuse lumos prepare signing entries method.
https://github.com/ckb-js/lumos/blob/e73ca0502b0feb3e98be848f76325a912052d0f0/packages/common-scripts/src/helper.ts#L186-L279

Thus, my code will seems like

  /**
   * request wallet to sign a transaction skeleton
   * @param txSkeleton The transaction skeleton, you can create it from transaction object via `@ckb-lumos` {@link createTransactionFromSkeleton}
   * @returns The signed transaction skeleton. To get the signed transaction object, please use {@link sealTransaction} with empty sealingContents(`[ ]`).
   */
  async signTransaction(txSkeleton: TransactionSkeletonType): Promise<TransactionSkeletonType> {
    const config = getConfigFromRpcUrl();

    prepareSigningEntries(txSkeleton, config);
    const groupedSignature = await this.ckb.request({
      method: 'wallet_fullOwnership_signTransaction',
      params: { tx: createTransactionFromSkeleton(txSkeleton) },
    });

    txSkeleton = txSkeleton.update('witnesses', (witnesses) => {
      return witnesses.map((witness, index) => {
        const [, signature] = groupedSignature[index];
        if (!signature) return witness;
        const witnessArgs = WitnessArgs.unpack(witness);
        return bytes.hexify(
          WitnessArgs.pack({
            ...witnessArgs,
            lock: signature,
          }),
        );
      });
    });

    txSkeleton = txSkeleton.update('signingEntries', (signingEntries) =>
      signingEntries.splice(0, groupedSignature.length),
    );

    return txSkeleton;
  }

[zhangyouxin]

why do we need to clear signingEntries here

[zhangyouxin]

pro usage, not easy to understand though

[homura]

Insufficient coverage of unit tests, can you add tests?

[IronLu233]

can you try the coverage detection method mentioned in this post?

      <line num="138" count="10" type="cond" truecount="1" falsecount="0"/>

But it seems the coverage is wrong. jest tells me the if statement is full covered.

[homura]

we should check if the fee is paid to avoid repeating fee payment

if (inputCapacitys - outputsCapacity >= neededFee) {
  return tx
}

[zhangyouxin]

The logic of detecting if tx-fee is already paid: https://github.com/ckb-js/nexus/pull/127/files#diff-4212a8e65e25ac3827c0789664613414267d82d12237316f5b3adf09ac533476R209-R215

Is it better to run this logic before validating input parameters?

[IronLu233]

I think validating parameter first is better.

Thinking the user give a invalid parameter, but because of detecting tx fee already paid, it is not throw.

It is not Intuitive.

[homura]

// FIXME detect if it is a DAO unlock transaction first

[homura]

// **NOT** support DAO unlock transaction yet, please consider using `lumos`'s `payFee`

[homura]

@IronLu233 could you comment for the payFee does not support unlocking DAO transaction yet

[github-actions]

🚀 PR was released in v0.0.10 🚀