This repository houses TypeScript implementations of the Celo Payments Protocol libraries. Currently these include the Charge SDK and a reference server.
This is the exhaustive list of requirements to run this repository
node 12yarn- A
CELOprivate key for development purposes. - A
DEKfor development purposes.
The following is a short description of each of the package directories:
packages/cli - CLI code and scripts that demonstrate the SDK capabilities
packages/sdk - the actual SDK implementation code
packages/server - an example/reference code that demonstrate how a typical server might use the SDK
packages/types - protocol compliant schemas and types
For one-off uses, simply use celocli account:new. To get the CELO CLI, follow the instructions here: https://docs.celo.org/command-line-interface/introduction.
To make things a bit simpler, I recommend running that command to create a .env file for testing:
# Make sure you're working on alfajores network
celocli config:set --node https://alfajores-forno.celo-testnet.org/
If this is the first time you're running this command, the script will create a blockchain account/private-key for you and ask you to fund it using Celo faucet. Then this account will be used automatically to pay for the requested payment.
# Create an account and store it well formatted in an .env file
celocli account:new | sed -E 's/: (.+)/="\1"/g' | grep '=' > .env
source .env
# Copy the account address to your clipboard
echo $accountAddress | pbcopy
# Head to the faucet to get some money and paste your account address there
open https://celo.org/developers/faucet
# Verify you got money successfully
celocli account:balance $accountAddress
# Register your account
celocli account:register --from $accountAddress -k $privateKey
For the server to know about your DEK, your account created above needs to be registered and have the public key of your DEK registered too.
First, some context: the payment SDK is meant to be used within Valora initially, and they already handle creating keys and accounts under the hood for the user. However, it's important to understand why you need to sign with a different key than the root key of your account. Generally we want a separation of concerns when dealing with private keys, they should do one thing and one thing only. Your account key, as it can move funds, is like the keys to the castle and should be kept as cold as possible. Your DEK, vote signing key, etc are less sensitive a
In order to do that, this command may be useful:
# Register a public data encryption key
celocli account:register-data-encryption-key --from $accountAddress -k privateKey --publicKey <DEK_PUBLIC_KEY>
The payments monorepo is composed of a couple packages. But only 2 are meant to be used from the outside: the CLI and the development server. The other packages (sdk, types, and utils) are used by the CLI and server respectively.
First, run yarn && yarn lerna bootstrap to install the dependencies and bootstrap the monorepo.
You can run yarn start to run the server with hot-reloading enabled. It will run by default on port 3000, useful for the next section.
Run the payment CLI in interactive mode yarn cli init -p <PRIVATE_KEY> -d <DEK> -u http://localhost:3000 -r SIMPLE from the root of the repository. You can also see the full list of available flags via yarn cli init --help and all available commands via yarn cli help.
You may also omit all the flags to run the command interactively.
The reference servers implements two types of payments: KYC and SIMPLE, you try both via the -r flag. If you decide to implement a new purchase example, you can find them in the folder packages/server/src/storage/items.