@shakesco/automation/README.md

shakesco automation package

# @shakesco/automation

This repository makes it easy for businesses to interact with their
auto-payment contract and enable automation!

Before intergrating please read this [short explanation on how the system works](https://docs.shakesco.com/docs/autopayments/integration/ "explain shakesco automation"). It will help you understand how you may want to setup your autopayments.

To install:

```shell
npm i @shakesco/automation
```

After installing:

```javascript
const { Automation, parseUnits } = require("@shakesco/automation");
```

## Test

>📓 __NOTE__: 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.

First request a delegate address:

```javascript
  const your_smart_wallet_address = "";

  const shakescocontract = new Automation(
    your_smart_wallet_address, // business smart wallet address
    process.env.SHAKESCOAPIKEY,
    "11155111"
  );

  const requestAddress = await shakescocontract.testDelegateAddressBuss(); //request test address

  console.log(requestAddress);
  // {
  //   id: "1",
  //   test_delegate_address: "0x472ef8282b420396ad307cb89f542e60b1dec1a1",
  // }
```

Then send a request:

```javascript
  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
```

>📓 __NOTE__: 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

>📓 __NOTE__: Visit [__Shakesco__](https://shakesco.com/pricing "Shakesco") to get fee rates and then get your api keys [here](https://users.shakesco.com). If you want to see the fee charged for every transaction, go [__here__](https://shakesco.com/charges "Shakesco")

To check if you can request a certain user [check here](#can-request). To check which payer you are requesting, [check here](#check-payer)

When ready to go live, here's how to send a request to a user or business:

* Ask the user for their Shakesco card address.
* If the request is for a business, ask for their Business card address.

```javascript
  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
```

>📓NOTE: Period should be in seconds. Amount should be in usd. Eg: "20" is in usd. Boolean values are returned as __STRINGS__

### Can Request

Before requesting, check if the payer can be requested. If not, they should accept requests from there Shakesco app.

```javascript
  const your_smart_wallet_address = ""; // get on your dashboard https://users.shakesco.com/login

  const shakescocontract = new Automation(your_smart_wallet_address, process.env.SHAKESCOAPIKEY, "1");

  const delegateAddress = /*Ask user/business for their Shakesco card/delegate/business card ONLY.*/

  const canre = await shakescocontract.canRequest(delegateAddress);
  console.log(canre); // {"id":1,"status":"true"}
```

### Check Payer

Before requesting, check if the payer is a business or user. Businesses and customers have different [charges](https://shakesco.com/charges) per every successful transaction.

```javascript
  const your_smart_wallet_address = ""; // get on your dashboard https://users.shakesco.com/login

  const shakescocontract = new Automation(your_smart_wallet_address, process.env.SHAKESCOAPIKEY, "1");

  const delegateAddress = /*Ask user/business for their Shakesco card/delegate/business card ONLY.*/

  const canre = await shakescocontract.isBusiness(delegateAddress);
  console.log(canre); // {"id":1,"is_business":false}
```

### Split

When you want to request split payment:

>📓 __NOTE__: Read [this](https://docs.shakesco.com/docs/autopayments/integration#split) to understand split payments.

```javascript
  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
  }
```

### Request Tokens

When you want to request a token:

>📓 __NOTE__: Read [this](https://docs.shakesco.com/docs/autopayments/integration#requesting-token) to understand token payments.

```javascript
  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
```

### Check Payment

To check if user has made payment or not:

```javascript
  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"
```

>⚠️WARNING: 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](https://shakesco.com/contact "Shakesco")!

ENJOY YOUR FINANCIAL FREEDOM😁!!!