Hackathon deployment
Experimental! Deploy your chaincode
For the first time we're able to provide you with the ability to deploy chaincode and make it public. This is an experimental feature, there might be some glitches, and at some point all the data will be probably removed.
How to deploy:
1 Build and publish your chaincode as a docker image in public repo (for instance DockerHub, GitHub registry or GitLab registry). Remember to docker login before pushing.
Sample for DockerHub (It uses the ttl.sh to make it available for 1 day):
Provide us the image name (everything before the : character of full docker tag). In the sample above it is the content of ttl.sh/<IMAGE_NAME>.
2 Provide us your secp public admin key for chaincode, and secp public developer key.
The keys are automatically generated when you initialize the project using galachain init, so you can find these keys in keys/gc-admin-key.pub and keys/gc-dev-key.pub.
Note: The developer key should be shared with all team members who want to deploy the chaincode.
If you can't find the keys, you can generate them using the following commands:
The above command creates a private keys in ./gc-admin-key and ./gc-dev-key, and public keys in ./gc-key.pub, ./gc-dev-key.pub. We need the content of *.pub files for chaincode admin user and for developer user who want to deploy. All the team members will use only one developer key, so make sure to share this with the other team member who want to deploy. Keep private keys safe, they will be needed later.
3 Once we register your public keys, you will be able to connect your chaincode with GalaChain. To do it, navigate to the root directory of your chaincode and call the following command, providing path to developer private key:
4 If your docker image is published, and your chaincode is connected, you can deploy it to our sandbox environment with the command:
Note: you need to provide docker image name and also the version part. If you used the ttl.sh example, the ttl.sh/<IMAGE_NAME>:1d.
5 You can check the status of your deployment with the command:
Once the status is CC_DEPLOYED you can visit the Swagger webpage: https://gateway.stage.galachain.com/docs/. You can find your chaincode (gc-<eth-addr>). If the version is still unknown (and you see v?.?.?), it means you may need to wait a couple of minutes till the chaincode is ready.
Once it is ready, you can use the webpage to call chaincodes. It's good to start PublicKeyContract/GetPublicKey with empty object as request body. It should return the admin public key you provided before.
6 Call the deployed chaincode
You can use any REST API client (like axios to call your chaincodes). Remember in most cases you will need to sign the DTO with either the gc-admin-key or any key of registered user.
We highly recommend to use the @gala-chain/api library for handling DTOs and signing. For instance, you can register a user by calling /api/.../...-PublicKeyContract/RegisterEthUser and providing the following RegisterEthUser as payload:
const dto = new RegisterEthUser();
dto.publicKey = <newUserPublicKey>;
dto.sign(<gc-admin-key>);
const payloadString = dto.serialize();
In the current version of the library, local environment exposes slightly different endpoints than the production environment.
gcclient and @gala-chain/client packages are compatible with the local environment only.
For calling the production environment, you should consult the Swagger documentation at https://gateway.stage.galachain.com/docs/, and use generic REST API client.