SDK
Before getting started, please obtain your API keys from the dashboard and deploy your Business Auto account through the Shakesco app.
Refer to the Integration guide for instructions on parsing values. Additionally, visit the Start section to ensure your auto-payment account is configured to process payments.
If you want to test out the system, just go here.
@shakesco/automation
This repository makes it easy for businesss to interact with their autopayment contract and enable automation!
Before intergrating please read this short explanation on how the system works. It will help you understand how you may want to setup your auto-payments.
Install
cmd
npm i @shakesco/automationAfter installing:
index.js
const { Automation, parseUnits } = require("@shakesco/automation");Test
ℹ️
We fund your test delegate address automatically, so you don’t need to enter an amount in testing mode.
Before getting started, send a test request to make sure everthing is okay.
Request test address
First, request a delegate address by entering your business smart wallet address (it’s the same for both Ethereum and Polygon) along with your API key:
index.js
const your_smart_wallet_address = "";
const shakescocontract = new Automation(
your_smart_wallet_address,
process.env.SHAKESCOAPIKEY,
"11155111"
);
const requestAddress = await shakescocontract.testDelegateAddressBuss(); //request test address
console.log(requestAddress);
// {
// id: "1",
// test_delegate_address: "0x472ef8282b420396ad307cb89f542e60b1dec1a1",
// }
Test Request
Then send a request:
index.js
const address = ""; // Your test delegate address you requested above
const shakescocontract = new Automation(
address,
process.env.SHAKESCOAPIKEY,
"11155111");
const period = "86400" //1 day
const requestUser = await shakescocontract.requestUser(
"0x309E7d835ccE6E74BC72A2E523fa7f79FFC0d413", // parse this address
"",
period,
"",
false,
[],
[]);//request user
console.log(requestUser);//Requested user successfully
ℹ️
Check if the request is sent to your Shakesco app. If you request business check on Business wallet side, if you request user, check on Personal wallet side.
Live
ℹ️
Request user
Send request to user. Ask user for Shakesco card/ Business card address.
index.js
const address = /* Initialize your automation address. Can be found in your dashboard https://users.shakesco.com */
const shakescocontract = new Automation(address, process.env.SHAKESCOAPIKEY, "1");
const period = "604800" //1 week
const amount = parseUnits("20", 18); //amount to request regularly
const delegateAddress = /*Ask user/business for their Shakesco card/delegate/business card ONLY.*/;
const requestUser = await shakescocontract.requestUser(delegateAddress, "", period, amount, false, [], []);//request user
const requestBusiness = await shakescocontract.requestBusiness(delegateAddress,"", period, amount);//or request business
console.log(requestUser);//Requested user successfully
console.log(requestBusiness);//Requested business successfully
ℹ️
Period should be in seconds. Amount should be in USD. Eg: “20” is in USD. Boolean values are returned as STRINGS
Request Split payment
ℹ️
Read about split payments here
When you want to request split payment:
index.js
const address = /* Initialize your automation/Shakesco auto/business auto address. Can be found in your dashboard https://users.shakesco.com */
const shakescocontract = new Automation(address, process.env.SHAKESCOAPIKEY, "1");
const period = "604800" //1 week
const mainAddress = /** Users Shakesco card/delegate/business card ONLY.*/
const friends = ["", ""]; //request friend details. Shakesco card/delegate/business card ONLY.
const friendsAmount = [parseUnits("10", 18), parseUnits("10", 18)];
const mainamount = parseUnits("10", 18);
const requestUser = await shakescocontract.requestUser(mainAddress, "", period, mainamount, true, friends, friendsAmount);//request user
console.log(requestUser); //Requested user successfully (Returns for mainAddress only)
//so check the rest, "friends".
for (let i = 0; i < friends.length; i++) {
const isrequested = await shakescocontract.isRequested(friends[i]);
console.log(isrequested); // true / false
}ℹ️
Amount should be in USD. Eg: “10” is in USD. Boolean values are returned as STRINGS
ℹ️
You will be receiving USD 30. But it is split among 3 friends.
Request Tokens
ℹ️
Get token addresses here
When you want to request a token:
index.js
const address = /* Initialize your automation address. Can be found in your dashboard https://users.shakesco.com */
const shakescocontract = new Automation(address, process.env.SHAKESCOAPIKEY, "137");
const period = "604800" //1 week
const amount = parseUnits("20", 18); //amount to request regularly
const delegateAddress = /*Ask user/business for their Shakesco card/delegate/business card ONLY.*/
const tokenAddress = "" //Make sure it is checksummed
const requestUser = await shakescocontract.requestUser(delegateAddress, tokenAddress, period, amount, false, [], []);//request user
const requestBusiness = await shakescocontract.requestBusiness(delegateAddress, tokenAddress, period, amount);//or request business
console.log(requestUser);//Requested user successfully
console.log(requestBusiness);//Requested business successfully
ℹ️
Amount should be in USD. Eg: “20” is in USD.
Check payment status
To check if user has made payment or not:
index.js
const address = /*Initialize your automation address*/
let delegateAddress = /*Request user for their info: Shakesco card/delegate/business card address ONLY*/
const shakescocontract = new Automation(address, process.env.SHAKESCOAPIKEY, "137");
const requestUser = await shakescocontract.hasPaid(delegateAddress);
console.log(requestUser); //"true"
⚠️
Check the above step where you are offering your service. Otherwise you will offer service for free without knowing.
ℹ️
For split auto-payment, service is only given to ‘group leader’. So always query them alone, the rest will just return false.
We also don’t offer daily automation. If your business requires daily automation please reach out to us!
ENJOY YOUR FINANCIAL FREEDOM😁!!!