Social Tokens - Contract and Backend

A (nearly) full-stack solution for social tokens that can be used by communities for prizes.

Contract

The contract is an implementation of EIP-4974, which describes social tokens. You can read more about the background on my blog post.

Contract Deployment

Contract can be deployed with the following steps:

1. Add a deployment account to brownie accounts with "brownie accounts add"
2. Define the network(s) in brownie you want to deploy to
3. Add a .env file and create an Infura ID, set as WEB3_INFURA_PROJECT_ID

• Optionally add a Polyscan token as POLYGONSCAN_TOKEN for instant verification

4. Use the deployment script by running: brownie run token/scripts/deploy_social_token.py --network <network_name>

• Suggest to deploy to an L2 like Polygon to save on gas

AWS Setup

An AWS Lambda function and API Gateway are used to receive events that kick off the transfer process. This is to enable the social tokens to be transferred through the smart contract automatically, without an operator having to manually send tokens to anyone participating in the ecosystem. This repo builds these resources with Terraform, which is an Infrastructure-as-Code (IaC) tool to automate building cloud resources. I will have more detailed instructions on how to use this code soon.

Frontend Setup

The API Gateway configured in the AWS Setup section assumes that a webhook will be used to trigger an event from a frontend that can kick off the backend social token transfer automatically when a certain event occurs. This repo does not make assumptions about what type of frontend should be used. The basic standards should be as follows:

1. The frontend is some type of storefront or social media site
2. The frontend has a method of opting users in - tokens should never be sent to users who have not consented to participation

Lambda Testing

Test setup on API - drop the below into the Body: { "walletAddress": "0x3a8eBfCcC377b09216586871be539aBFF9aB8ABf" }

Deleting Secrets

When you terraform apply and terraform destroy AWS Secrets Manager secrets, they do not auto-delete. This is because AWS Secrets Manager has built-in protection for secrets to ensure that accidentally deleted secrets can be recovered for a specific time window (seven days by default). To permanently delete old secrets:

• aws secretsmanager delete-secret --secret-id infura_id --force-delete-without-recovery
• aws secretsmanager delete-secret --secret-id wallet_private_key --force-delete-without-recovery