contracts

Apillon Contracts Service

Service allowing us to deploy and smart contract.

Table of Contents

1. Getting Started
2. Configuration
3. Deployment
4. License

Getting Started

Please read Development and Debug and Test documentation. These instructions will help you set up the development environment and run the microservice locally.

Configuration

Environment variables that have to be set:

/************************************************************
 * Contracts - Apillon Contracts Service
 ************************************************************/
/**
 *  function name
 */
CONTRACTS_FUNCTION_NAME: string;
CONTRACTS_FUNCTION_NAME_TEST: string;

/**
 * dev server port
 */
CONTRACTS_SOCKET_PORT: number;
CONTRACTS_SOCKET_PORT_TEST: number;

/**
 * Database config
 */
CONTRACTS_MYSQL_HOST: string;
CONTRACTS_MYSQL_PORT: number;
CONTRACTS_MYSQL_USER: string;
CONTRACTS_MYSQL_PASSWORD: string;
CONTRACTS_MYSQL_DEPLOY_USER: string;
CONTRACTS_MYSQL_DEPLOY_PASSWORD: string;
CONTRACTS_MYSQL_DATABASE: string;

// TEST
CONTRACTS_MYSQL_HOST_TEST: string;
CONTRACTS_MYSQL_PORT_TEST: number;
CONTRACTS_MYSQL_USER_TEST: string;
CONTRACTS_MYSQL_PASSWORD_TEST: string;
CONTRACTS_MYSQL_DATABASE_TEST: string;

/**
 * Contracts workers config
 */
CONTRACTS_AWS_WORKER_SQS_URL: string;
CONTRACTS_AWS_WORKER_LAMBDA_NAME: string;

Contract versioning

The underlying smart contracts is versioned such that if there are ever new breaking changes introduces to the smart contract, it will not break the interaction with previously deployed contract. For each contract type and corresponding chain type, there is an entry in the contract_version table which contains all the versions for that contract and chain type. By default, when creating a new collection, the highest version is considered.

Deployment

Please read Deployment documentation.

License

Copyright (c) Apillon - all rights reserved