Skip to content

Latest commit

 

History

History

omnilock

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
acp
acp
 
 
utils
utils
 
 
README.md
README.md
 
 
package.json
package.json
 
 
tsconfig.json
tsconfig.json
 
 

README.md

Spore Omnilock Examples

What is Omnilock lock

Omnilock is a universal and interoperable lock script supporting various blockchains' verification methods (Bitcoin, Ethereum, EOS, etc.) and extensible for future additions. You can create private spores and clusters with it for safeguarding ownership of your assets.

Omnilock also supports a Compatible ACP Mode, which allows you to create public Clusters and benefit from charging other users for creating Spores that references the public Clusters.

Please note that Omnilock ACP lock differs from the Anyone-can-pay lock in that it does not allow the minimal CKB or UDT (User-Defined Token) payment amount to be configured as undefined. This means that each transaction referencing an Omnilock ACP cell should receive a certain amount of payment.

Featured examples

Run examples

Please make sure you've met the pre-requirements:
Node.js >= 18.0.0
PNPM >= 8.0.0

Setup environment

To set up the local environment, run the following command at the root of the Spore SDK:

pnpm i && pnpm run build:packages

Run an example

Go to the current directory (examples/omnilock) and run an example:

ts-node acp/createAcpCluster.ts

Review transaction

This example constructs and sends a transaction that creates a spore on-chain. Once the transaction is sent, a hash value should be returned. You can later review the transaction on CKB Explorer:

https://pudge.explorer.nervos.org/transaction/{hash}

Customization

Update configs

If you have your own testing accounts, or if you want to configure the SporeConfig of the examples, you can go to the examples/omnilock/utils/config.ts file and update it. Inside the utils/config.ts file, you can:

  • Replace the default testing accounts with your own
  • Modify the default SporeConfig as needed

Use your own accounts

If you want a clean startup environment for testing the functionality of the Spore SDK, you can replace the default testing accounts with your own accounts. Whether locally or in globally, there has two default testing accounts being used, CHARLIE and ALICE.

How to replace them:

  • Replace locally: For replacing the testing accounts locally (only affects the secp256k1 examples), visit the examples/omnilock/utils/config.ts file and edit the accounts variable.
  • Replace globally: If you want to replace the testing accounts globally (affects all kinds of examples), you can visit the examples/shared/index.ts file and edit the accounts variable.

Generate testing accounts

For those who want to create new accounts for testing the examples, you can follow the steps below to create a new private key and claim some faucet CKBytes.

1. Generate a new account:

  1. Open the Generator Tool website
  2. Click the refresh icon (🔄) on the page to generate a new account
  3. Copy the new account's Private Key (256-bit) from the Private/Public Key block
  4. Replace any of the default testing accounts with the new account

2. Claim faucet CKBytes for the new account:

  1. Copy the new account's Nervos CKB Address from the Omni Lock (Ethereum) - Testnet block
  2. Open the Nervos Faucet website
  3. Paste the address into the address input, and click the Claim button
  4. Wait for a while until the faucet process is completed