@aut-labs/sdk/README.md

The TS/JS SDK package aims to make it easy for frontends/backends to integrate with Aut Smart Contracts

# AutSDK

[![NPM Version](https://badge.fury.io/js/@aut-labs%2Fsdk.svg)](https://www.npmjs.com/package/@aut-labs/sdk)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

AutSDK is a software development kit that provides a programming interface to interact with the Āut ecosystem. It allows developers to interact with AutID, DAOExpanderRegistry, HubRegistry, DAOTypes, PluginRegistry, ModuleRegistry, and many other contract iterfaces.

To learn more about Āut Product Suite, Protocols & Contracts, see [Āut Docs](https://docs.aut.id/v2/intro/what-is-aut)

## Table of Contents

- [Installation](#installation)
- [Getting Started](#getting-started)
- [API Reference](#api-reference)
  - [AutID](#autid)
    - [getAutID](#getautid)
    - [mint](#mint)
  - [DAOExpanderRegistry](#daoexpanderregistry)
    - [deployDAOExpander](#deploydaoexpander)
  - [HubRegistry](#hubregistry)
    - [deployHub](#deployhub)
  - [PluginRegistry](#pluginregistry)
    - [addPluginToDAO](#addplugintodao)
    - [getAllPluginDefinitions](#getallplugindefinitions)
    - [getAllPluginDefinitionsByDAO](#getallplugindefinitionsbydao)
    - [getPluginDefinitionByDAO](#getplugindefinitionbydao)
    - [getPluginDefinitionByType](#getplugindefinitionbytype)
  - [OnboardingByQuest](#onboarding-by-quest)
    - [activateQuest](#activatequest)
    - [applyForAQuest](#applyforaquest)
    - [withdrawFromAQuest](#withdrawfromaquest)
    - [getAllQuests](#getallquests)
    - [getQuestById](#getquestbyid)
    - [createQuest](#createquest)
    - [updateQuest](#updatequest)
    - [getTaskById](#gettaskbyid)
    - [getAllTasksAndSubmissionsByQuest](#getalltasksandsubmissionsbyquest)
    - [getAllTasksByQuest](#getalltasksbyquest)
    - [getAllTasksForAllQuests](#getalltasksforallquests)
    - [createTask](#createtask)
    - [removeTasks](#removetasks)
    - [submitTask](#submittask)
    - [finalizeFor](#finalizefor)
- [Biconomy (deprected)](#biconomy)

## <a name="installation"></a>Installation

To install the AutSDK package, you can use npm or yarn:

```bash
npm install @aut-labs/sdk
```
or
```bash
yarn add @aut-labs/sdk
```

## <a name="getting-started"></a>Getting Started

To get started with AutSDK, you need to instantiate the SDK and initialize it with the necessary configurations.

### Usage Example

```typescript
import AutSDK, {
  AutSDKConfig,
  AutID,
  DAOExpanderRegistry,
  HubRegistry,
  DAOTypes,
  PluginRegistry,
  ModuleRegistry,
  IPFSClient,
} from "@aut-labs/sdk";

const autSDKConfig: AutSDKConfig = {
  nftStorageApiKey: "YOUR_NFT_STORAGE_API_KEY",
};

const autIDAddress = "AUTID_ADDRESS";
const daoExpanderRegistryAddress = "DAO_EXPANDER_REGISTRY_ADDRESS";
const hubRegistryAddress = "HUB_REGISTRY_ADDRESS";
const daoTypesAddress = "DAOTYPES_ADDRESS";
const daoExpanderAddress = "DAO_EXPANDER_ADDRESS";
const pluginRegistryAddress = "PLUGIN_REGISTRY_ADDRESS";
const moduleRegistryAddress = "MODULE_REGISTRY_ADDRESS";

const sdk = new AutSDK(autSDKConfig);

const provider = new providers.Web3Provider(transport, network);
const readOnlyProvider = new providers.JsonRpcProvider(
    "json-rpc-url",
    network
);
const signer = provider.getSigner();
const readOnlySigner = readOnlyProvider.getSigner();

sdk.init({
  signer,
  readOnlySigner,
}, {
  autIDAddress,
  daoExpanderRegistryAddress,
  hubRegistryAddress,
  daoTypesAddress,
  daoExpanderAddress,
  pluginRegistryAddress,
  moduleRegistryAddress,
});
```

After instantiating and initializing the SDK, you can use the different services provided by the SDK, including AutID, DAOExpanderRegistry, HubRegistry, DAOTypes, PluginRegistry, ModuleRegistry.

To learn more about Product Suite, Protocols & Contracts, see [Āut Docs](https://docs.aut.id/v2/intro/what-is-aut)

## <a name="api-reference">API Reference</a>

### <a name="autid">AutID</a>

#### getAutID

Returns the AutID for the given query parameters.

```typescript
const sdk = AutSDK.getInstance();

const query: AutIDQuery = {
  username: string,
  holderAddress?: string,
  tokenId?: number,
};

const autID: HolderData = await sdk.autID.getAutID(query);
```

#### mint

Mints a new AutID.

```typescript
const sdk = AutSDK.getInstance();

const username: string = "john";
const role: number = 1;
const commitment: number = 100;
const daoExpanderAddr: string = "0x12345";
const network: string = "mumbai";
const avatarBase64: string = "ipfs-metadata-url";

const response: SDKContractGenericResponse<string> = await sdk.autID.mint(
  username,
  role,
  commitment,
  daoExpanderAddr,
  network,
  avatarBase64
);
```

### <a name="daoexpanderregistry">DAOExpanderRegistry</a>

#### deployDAOExpander

Deploys a new DAOExpander.

```typescript
const sdk = AutSDK.getInstance();

const newDAO: SDKContractGenericResponse<string> = await sdk.daoExpanderRegistry.deployDAOExpander();
```

### <a name="hubregistry">HubRegistry</a>

#### deployHub

Deploys a new Hub.

```typescript
const sdk = AutSDK.getInstance();

const newHub: SDKContractGenericResponse<string> = await sdk.hubRegistry.deployHub();
```

### <a name="pluginregistry">PluginRegistry</a>

#### addPluginToDAO

Adds a plugin to a DAO.

```typescript
const sdk = AutSDK.getInstance();

const request = {
  pluginDefinitionId: PluginDefinitionType,
  daoAddress: string,
  questOnboardingPluginAddress: string,
  offchainVerifier: string,
};

const response: SDKContractGenericResponse<boolean> = await sdk.pluginRegistry.addPluginToDAO(request);
```

#### getAllPluginDefinitions

Returns all the plugin definitions.

```typescript
const sdk = AutSDK.getInstance();

const response: SDKContractGenericResponse<PluginDefinition[]> = await sdk.pluginRegistry.getAllPluginDefinitions();
```

#### getAllPluginDefinitionsByDAO

Returns all the plugin definitions associated with a DAO.

```typescript
const sdk = AutSDK.getInstance();

const daoAddress: string = "0x12345";

const response: SDKContractGenericResponse<PluginDefinition[]> = await sdk.pluginRegistry.getAllPluginDefinitionsByDAO(daoAddress);
```

#### getPluginDefinitionByDAO

Returns the plugin definition for a specific DAO.

```typescript
const sdk = AutSDK.getInstance();

const daoAddress: string = "0x12345";

const response: SDKContractGenericResponse<PluginDefinition> = await sdk.pluginRegistry.getPluginDefinitionByDAO(daoAddress);
```

#### getPluginDefinitionByType

Returns the plugin definition for a specific plugin type and DAO.

```typescript
const sdk = AutSDK.getInstance();

const daoAddress: string = "0x12345";
const type: PluginDefinitionType = PluginDefinitionType.OnboardingJoinDiscordTaskPlugin;

const response: SDKContractGenericResponse<string> = await sdk.pluginRegistry.getPluginDefinitionByType(daoAddress, type);
```

### <a name="daoexpander">DAOExpander</a>

#### addAdmin

Adds an admin to the DAOExpander.

```typescript
const sdk = AutSDK.getInstance();

const address: string = "0x12345";

const response: SDKContractGenericResponse<boolean> = await sdk.daoExpander.addAdmin(address);
```

#### removeAdmin

Removes an admin from the DAOExpander.

```typescript
const sdk = AutSDK.getInstance();

const address: string = "0x12345";

const response: SDKContractGenericResponse<boolean> = await sdk.daoExpander.removeAdmin(address);
```

#### activateModule

Activates a module in the DAOExpander.

```typescript
const sdk = AutSDK.getInstance();

const moduleId: number = 1;

const response: SDKContractGenericResponse<boolean> = await sdk.daoExpander.activateModule(moduleId);
```

#### isModuleActivated

Checks if a module is activated in the DAOExpander.

```typescript
const sdk = AutSDK.getInstance();

const moduleId: number = 1;

const response: SDKContractGenericResponse<boolean> = await sdk.daoExpander.isModuleActivated(moduleId);
```

### <a name="hub">Hub</a>

#### activateModule

Activates a module in the Hub.

```typescript
const sdk = AutSDK.getInstance();

const moduleId: number = 1;

const response: SDKContractGenericResponse<boolean> = await sdk.hub.activateModule(moduleId);
```

#### isModuleActivated

Checks if a module is activated in the Hub.

```typescript
const sdk = AutSDK.getInstance();

const moduleId: number = 1;

const response: SDKContractGenericResponse<boolean> = await sdk.hub.isModuleActivated(moduleId);
```

### <a name="onboarding-by-quest">OnboardingByQuest</a>

#### activateQuest

Activates a quest.

```typescript
const sdk = AutSDK.getInstance();

const questId: number = 1;

const response: SDKContractGenericResponse<boolean> = await sdk.questOnboarding.activateQuest(questId);
```

#### applyForAQuest

Applies for a quest.

```typescript
const sdk = AutSDK.getInstance();

const questId: number = 1;

const response: SDKContractGenericResponse<boolean> = await sdk.questOnboarding.applyForAQuest(questId);
```

#### withdrawFromAQuest

Withdraws from a quest.

```typescript
const sdk = AutSDK.getInstance();

const questId: number = 1;

const response: SDKContractGenericResponse<boolean> = await sdk.questOnboarding.withdrawFromAQuest(questId);
```

#### getAllQuests

Returns all the quests.

```typescript
const sdk = AutSDK.getInstance();

const response: SDKContractGenericResponse<Quest[]> = await sdk.questOnboarding.getAllQuests();
```

#### getQuestById

Returns a quest by its ID.

```typescript
const sdk = AutSDK.getInstance();

const questId: number = 1;

const response: SDKContractGenericResponse<Quest> = await sdk.questOnboarding.getQuestById(questId);
```

#### createQuest

Creates a new quest.

```typescript
const sdk = AutSDK.getInstance();

const quest: Quest = {
  title: "New Quest",
  description: "Quest description",
  reward: 100,
  tasks: [],
};

const response: SDKContractGenericResponse<Quest> = await sdk.questOnboarding.createQuest(quest);
```

#### updateQuest

Updates an existing quest.

```typescript
const sdk = AutSDK.getInstance();

const quest: Quest = {
  id: 1,
  title: "New Quest",
  description: "Quest description",
  reward: 100,
  tasks: [],
};

const response: SDKContractGenericResponse<Quest> = await sdk.questOnboarding.updateQuest(quest);
```

#### getTaskById

Returns a task by its ID.

```typescript
const sdk = AutSDK.getInstance();

const taskAddress: string = "0x12345";
const taskId: number = 1;

const response: SDKContractGenericResponse<Task> = await sdk.questOnboarding.getTaskById(taskAddress, taskId);
```

#### getAllTasksAndSubmissionsByQuest

Returns all the tasks and submissions for a quest.

```typescript
const sdk = AutSDK.getInstance();

const questId: number = 1;

const response: SDKContractGenericResponse<{
  tasks: Task[];
  submissions: Submission[];
}> = await sdk.questOnboarding.getAllTasksAndSubmissionsByQuest(questId);
```

#### getAllTasksByQuest

Returns all the tasks for a quest.

```typescript
const sdk = AutSDK.getInstance();

const questId: number = 1;
const userAddress: string = "0x12345";

const response: SDKContractGenericResponse<Task[]> = await sdk.questOnboarding.getAllTasksByQuest(questId, userAddress);
```

#### getAllTasksForAllQuests

Returns all the tasks for all quests.

```typescript
const sdk = AutSDK.getInstance();

const filterQuests: Quest[] = [];

const response: SDKContractGenericResponse<Task[]> = await sdk.questOnboarding.getAllTasksForAllQuests(filterQuests);
```

#### createTask

Creates a new task for a quest.

```typescript
const sdk = AutSDK.getInstance();

const task: Task = {
  title: "New Task",
  description: "Task description",
  reward: 10,
  pluginData: [],
  isRequired: true,
};

const questId: number = 1;
const pluginTokenId: number = 1;

const response: SDKContractGenericResponse<Task> = await sdk.questOnboarding.createTask(
  task,
  questId,
  pluginTokenId
);
```

#### removeTasks

Removes tasks from a quest.

```typescript
const sdk = AutSDK.getInstance();

const tasks: Task[] = [];
const questId: number = 1;
const pluginId: number = 1;

const response: SDKContractGenericResponse<Task[]> = await sdk.questOnboarding.removeTasks(
  tasks,
  questId,
  pluginId
);
```

#### submitTask

Submits a task with its plugin data.

```typescript
const sdk = AutSDK.getInstance();

const task: Task = {
  title: "Task Title",
  description: "Task Description",
  reward: 10,
  pluginData: [],
  isRequired: true,
};

const taskPluginAddress: string = "0x12345";
const pluginDefinitionId: PluginDefinitionType = PluginDefinitionType.OnboardingJoinDiscordTaskPlugin;

const response: SDKContractGenericResponse<Task> = await sdk.questOnboarding.submitTask(
  task,
  taskPluginAddress,
  pluginDefinitionId
);
```

#### finalizeFor

Finalizes a submission for a task.

```typescript
const sdk = AutSDK.getInstance();

const submission: Task = {
  title: "Submission Title",
  description: "Submission Description",
  reward: 10,
  pluginData: [],
  isRequired: true,
};

const taskPluginAddress: string = "0x12345";
const pluginDefinitionId: PluginDefinitionType = PluginDefinitionType.OnboardingJoinDiscordTaskPlugin;

const response: SDKContractGenericResponse<Task | void> = await sdk.questOnboarding.finalizeFor(
  submission,
  taskPluginAddress,
  pluginDefinitionId
);
```

## <a name="biconomy">Biconomy (deprecated)</a>

AutSDK also supports biconomy for gasless transactions.

```typescript
import AutSDK, {
  AutSDKConfig,
  AutID,
  DAOExpanderRegistry,
  HubRegistry,
  DAOTypes,
  PluginRegistry,
  ModuleRegistry,
  IPFSClient,
} from "@aut-labs/sdk";

const autSDKConfig: AutSDKConfig = {
  nftStorageApiKey: "YOUR_NFT_STORAGE_API_KEY",
};

const autIDAddress = "AUTID_ADDRESS";
const daoExpanderRegistryAddress = "DAO_EXPANDER_REGISTRY_ADDRESS";
const hubRegistryAddress = "HUB_REGISTRY_ADDRESS";
const daoTypesAddress = "DAOTYPES_ADDRESS";
const daoExpanderAddress = "DAO_EXPANDER_ADDRESS";
const pluginRegistryAddress = "PLUGIN_REGISTRY_ADDRESS";
const moduleRegistryAddress = "MODULE_REGISTRY_ADDRESS";

const sdk = new AutSDK(autSDKConfig);

const provider = new providers.Web3Provider(transport, network);
const readOnlyProvider = new providers.JsonRpcProvider(
    "json-rpc-url",
    network
);
const signer = provider.getSigner();
const readOnlySigner = readOnlyProvider.getSigner();

const biconomy = new SDKBiconomyWrapper({
  enableDebugMode: true,
  apiKey: "biconomy-api-key",
  contractAddresses: ["address1, address2"]
});

sdk.init({
  signer,
  readOnlySigner,
},
{
  autIDAddress,
  daoExpanderRegistryAddress,
  hubRegistryAddress,
  daoTypesAddress,
  daoExpanderAddress,
  pluginRegistryAddress,
  moduleRegistryAddress,
},
  biconomy
);
```