dsa-developers/README.md

# Developing on DSA
We empower third-party developers to build dapps, use-cases, and other integrations on DSA’s platform. That way, users can get curated experience as per their needs, and developers can build their own businesses supporting those users. This virtuous circle creates new opportunities and benefits users, developers, and protocols.

## Index
- [Developing on DSA](#developing-on-dsa)
  - [Index](#index)
  - [Get Started](#get-started)
  - [Get Accounts](#get-accounts)
    - [Parameters](#parameters)
    - [Returns](#returns)
  - [Set Instance](#set-instance)
    - [Parameters](#parameters-1)
  - [Build DSA](#build-dsa)
    - [Parameters](#parameters-2)
    - [Returns](#returns-1)
  - [Interact with DSA](#interact-with-dsa)
    - [Parameters](#parameters-3)
    - [Returns](#returns-2)

## Get Started

To get started, install the DSA SDK package from NPM:

```bash
npm install dsa-sdk
```

You can also import the build from CDN:

```js
<script src="https://cdn.jsdelivr.net/npm/dsa-sdk@1.2.0/build/dsa.min.js"></script>
```

For production, we recommend linking to a specific version number ([jsdeliver](https://www.jsdelivr.com/package/npm/dsa-sdk)).

Now instantiate Web3 and DSA.

```js
const dsa = new DSA()
if (window.ethereum) {
  window.web3 = new Web3(window.ethereum)
} else if (window.web3) {
  window.web3 = new Web3(window.web3.currentProvider)
} else {
  console.log('Non-Ethereum browser detected. You should consider trying MetaMask!')
}
```


## Get Accounts

Once connected to a web3 client, get all the DSA where a specific address is authorised.

```js
let accounts = await web3.eth.getAccounts()
dsa.getAccounts(accounts[0])
  .then(data => {
    return data
  })
  .catch(error => {
    return error
  })
```

### Parameters
`address` - An ethereum address.

### Returns
`Array` of `Object` with all the DSA where `address` parameter is authorised.

```js
[
  {
    id: 52, // DSA Number
    account: "0x...", // DSA Address
    version: 1 // DSA version
  },
  ...
]
```

Web3 equivalent of the above (return value might have different format):
```js
let ABI = [] // => https://github.com/InstaDApp/dsa-sdk/blob/master/src/abi/resolvers/core.json
let contract = "0xD6fB4fd8b595d0A1dE727C35fe6F1D4aE5B60F51"
let accounts = await web3.eth.getAccounts()
new web3.eth.Contract(ABI, contract);
  .getOwnerDetails(accounts[0])
  .call({ from: "0x..." })
  .then((data) => {
    return data
  })
  .catch((error) => {
    return error
  });
```


## Set Instance

Once you get the DSA(s), set some common values so you don't have to pass similar arguments in further calls.

```js
let accounts = await web3.eth.getAccounts();
let dsaAccount = dsa.getAccounts(accounts[0])
dsa.setInstance({
  id: dsaAccount[0].id,
  account: dsaAccount[0].account,
  origin: "0x..." // optional
})
```

### Parameters
1. `Object`
   * `id` - `Number`: The number of DSA.
   * `account` - `String`: The address of DSA.
   * `origin` - `String`: The address to track the transaction origination (affiliates).


## Build DSA

Build a new DSA.

```js
dsa.build()
  .then(data => {
    return data
  })
  .catch(error => {
    return error
  })
```

### Parameters
1. `Object` (ALL optional)
   * `owner`: The authorised address which will be authorised on DSA (defaulted to selected address).
   * `origin` - `String`: The address to track the transaction origination (affiliates).
   * `from` - `String`: The address transactions should be made from (defaulted to selected address).
   * `gasPrice` - `String`: The gas price in wei to use for transactions.
   * `gas` - `Number`: The maximum gas provided for a transaction (gas limit).

### Returns
`String`: Transaction hash `0x.....`.

Web3 equivalent of the above (return value might have different format):
```js
let ABI = [] // => https://github.com/InstaDApp/dsa-sdk/blob/master/src/abi/core/index.json
let contract = "0xD6fB4fd8b595d0A1dE727C35fe6F1D4aE5B60F51"
let accounts = await web3.eth.getAccounts()
let owner = "0x..."
let version = 1;
let origin = "0x..."
new web3.eth.Contract(ABI, contract).methods
  .build(owner, version, origin)
  .send({
    from: accounts[0]
  })
  .on("transactionHash", (txHash) => {
    return txHash;
  })
  .on("error", (error) => {
    return error;
  });
```

## Interact with DSA

Once the DSA is build, use this function to interact with your DSA. This is where you'll interact with other smart contracts like DeFi protocols.

Create a new instance.
```js
let spells = dsa.Spell();
```

Add the series of transactions details in the instance.
```js
spells.add({
 connector: "basic", // protocol name
 method: "deposit", // protocol method
 args: [dsa.token.usdc.address, 1000000, 0, 1] // protocol method arguments
})
spells.add({
 connector: "basic",
 method: "withdraw",
 args: [dsa.token.usdc.address, 0, "0x03d70891b8994feB6ccA7022B25c32be92ee3725", 1, 0]
})
```

Note: You can get the specific input interface by calling `dsa.getInterface(connector, method)`

Send the transaction to blockchain. CAST YOUR SPELL.

```js
dsa.cast(spells) // or dsa.cast({data:spells})
  .then(data => {
    return data
  })
  .catch(error => {
    return error
  })
```

### Parameters
1. `Instance` - The spell instance.
OR
1. `Object`
   * `data` - The spell instance.
   * `from` - `String` (optional): The address transactions should be made from (defaulted to selected address).
   * `gasPrice` - `String` (optional): The gas price in wei to use for transactions.
   * `gas` - `Number` (optional): The maximum gas provided for a transaction (gas limit).

### Returns
`String`: Transaction hash `0x.....`.

Web3 equivalent of the above (return value might have different format):
```js
let ABI = [] // => https://github.com/InstaDApp/dsa-sdk/blob/master/src/abi/core/account.json
let contract = "0x..." // DSA address
let origin = "0x..."
let accounts = await web3.eth.getAccounts()
new web3.eth.Contract(ABI, contract).methods
  .cast(
    ["0x...", "0x..."], // Array of target addresses
    ["0x......", "0x......"], // Array of encoded function call, check encodeFunctionCall
    origin
  )
  .send({
    from: accounts[0]
  })
  .on("transactionHash", (txHash) => {
    return txHash;
  })
  .on("error", (error) => {
    return error;
  });
```

Our team is super active to assist you with all of your queries at our [TG developer group](https://t.me/instadevelopers) or [discord channel](https://discord.gg/83vvrnY).