Devdocs

.env.example

@@ -0,0 +1,5 @@
+PERMISSION=active
+NETWORK_NAME=mainnet
+ACTOR=eosaccountname
+PRIVATE_KEY=private_key_here
+PUBLIC_KEY=public_key_here

.gitignore

@@ -17,8 +17,10 @@ lerna-debug.log*
 .env.development.local
 .env.test.local
 .env.production.local
+.env.testnet
+.env.mainnet
 .envrc
 
 # ignore lock files other then bun.
 package-lock.json
-yarn.lock
+yarn.lock

README.md

@@ -13,6 +13,16 @@ If you want to add contributions to this repository, please follow the instructi
 ## 🏠 Local Development
 Follow the docs to Set Up Your Local Development Environment to contribute to the framework and documentation. 
 
+### Testing
 
+#### `.env`
+
+To run the tests locally, you will need to provide an EOS account that can be used to make transactions on your behalf.
+Copy the `.env.example` file to `.env.testnet` and fill in the required parameters.
+
+#### PowerUp
+
+You might need to power up your account, either by adding some Native Token to your account or EFX tokens.
+You can powerup your account at the following link: https://monitor4.jungletestnet.io/
 
 

docs/pages/docs/compatibility.mdx

@@ -1,3 +1,5 @@
 # Compatibility 
 
-The Effect AI SDK is compatible with all Node.js environments, including browsers and React Native.
+The Effect AI SDK is compatible with all Node.js environments, including browsers and React Native.
+It might be necessary to use a particular `fetch` polyfill in some environments.
+You can read more about it [here](./glossary/client_options.mdx)

docs/pages/docs/gettingStarted.mdx

@@ -0,0 +1,157 @@
+# Getting Started [Get started with the SDK in just a few lines of code.]
+
+## Overview
+
+## Installation
+
+Use your favorite package manager to install the SDK.
+
+  :::code-group
+
+  ```bash [npm]
+
+  npm i @effectai/effect-js
+  ```
+
+  ```bash [bun]
+  bun i @effectai/effect-js
+  ```
+
+  ```bash [pnpm]
+  pnpm i @effectai/effect-js
+  ```
+  :::
+## Quick Start
+
+### 1. Import the SDK
+
+```ts
+import { createClient } from '@effectai/effect-js'
+```
+
+### 2. Instantiate the EffectAI Client
+
+Here the handy dandy `createClient` function is used to create a client instance.
+It takes two optional arguments, the first one is the network configuration, the second one is the options object.
+You can read more about the options object in the [ClientOptions](#client-options) section.
+
+```ts
+// This would be ideal, the big question is if using mainnet should be explicitly passed or not.
+const client = createClient()
+
+// But currently it is like this:
+import { jungle4 } from '@effectai/effect-js'
+// Atleast the opts ({}) object is now optional
+const client = createClient(jungle4)
+```
+
+### 3. Interact with the Client
+
+The sdk is built using a stateless model, meaning that all the functions are pure and do not mutate the client object.
+This means, that you need to creat one client, and you can pass that client as an argument to functions to make transactions.
+
+Here is an example of how to get the balance of an account, assuming that the client is already set up as described above.
+
+```ts
+import { getVAccounts, getAccountById } from "@effectai/effect-js";
+import { Name } from "@wharfkit/antelope";
+
+const actor = Name.from("forcedev1234");
+// Notice we are passing the clinet as an argument to the function.
+const [vacc] = await getVAccounts({ client, actor });
+
+console.log(vacc)
+/**
+{
+  id: 24,                                                
+  nonce: 0,
+  address: [ "name", "forcedev1234" ],
+  balance: {
+    quantity: "0.0000 EFX",
+    contract: "efxtoken1112",
+  },
+}
+*/
+```
+
+### 4. Set up wallet and session
+
+If you want to make transactions, such as creating a new account, creating a new tasks, or transfering tokens, you need to set up a wallet and a session.
+The wallet plguin is an interface that allows you to sign transactions and interact with the blockchain.
+The SDK comes with a few wallet plugins out of the box, but you can also create your own.
+
+In this example we will use the `WalletPluginPrivateKey` plugin, which requres a private key to be passed in.
+
+Afterwards we can set up the Session object, which allows us to specify other parameters like the actor, permission, and the blockchain netork.
+
+Last but not least we connect the session to the client, and the client will be ready to use.
+
+```ts
+import { createBatch, createVAccount } from "@effectai/effect-js";
+import { Session } from "@wharfkit/session";
+import { WalletPluginPrivateKey } from "@wharfkit/wallet-plugin-privatekey"
+
+const walletPlugin = new WalletPluginPrivateKey("your_private_key_here")
+
+const session = new Session({
+    actor: "forcedev1234",
+    permission: "active",
+    walletPlugin,
+    chain: {
+		  id: jungle4.eosChainId,
+		  url: jungle4.eosRpcUrl,
+    },
+})
+
+// Connect the session to the client.
+await session.setSession(session)
+
+// Now you can use the client to make authenticated transactions.
+const account = Name.from("efxforce1112");
+await createVAccount({ client, account });
+```
+
+## Full example
+
+```ts
+import { Session, Name } from "@wharfkit/session";
+import { WalletPluginPrivateKey } from "@wharfkit/wallet-plugin-privatekey";
+import {
+	createClient,
+	jungle4,
+	eos, // Use `eos` to use mainnet
+	getVAccounts,
+	createVAccount,
+} from "@effectai/effect-js";
+
+const client = createClient({ network: jungle4 });
+
+// Make unauthenticated requests
+const actor = Name.from("forcedev1234");
+const [vacc] = await getVAccounts({ client, actor });
+
+// Set up wallet with privatekey
+const walletPlugin = new WalletPluginPrivateKey("your_private_key_here");
+
+// Set up session with wallet and chain
+const session = new Session({
+	actor: "forcedev1234",
+	permission: "active",
+	walletPlugin,
+	chain: {
+		id: jungle4.eosChainId,
+		url: jungle4.eosRpcUrl,
+	},
+});
+
+// Connect session to client
+await client.setSession(session);
+
+// Now you can use the client to make authenticated transactions.
+const account = Name.from("efxforce1112");
+await createVAccount({ client, account });
+```
+
+Now that we have a basic understaning of how to set up the client, we can move on to more advanced topics.
+Read more on the following pages.
+

docs/pages/docs/glossary/clientOptions.mdx

@@ -0,0 +1,50 @@
+# Client Options 
+
+The ClientOpts interface is used to define the options that can be passed to the EffectAI Client constructor.
+
+```typescript
+interface ClientOpts {
+  ipfsCacheDurationInMs?: number | null;
+  fetchProvider?: FetchProviderOptions;
+  cacheImplementation?: Cache;
+}
+```
+
+As we can see, the ClientOpts interface has three optional properties:
+
+## `ipfsCacheDurationIMs`
+
+This property is used to set the cache duration for the IPFS data. 
+ The default value is 600_000 milliseconds; 10 minutes.
+
+## `fetchProfider`
+
+This property is used to set the fetch provider. 
+This is needed because of the different runtimes availalbe to Java Script.
+For example, in older versions of Node.js, the fetch API is not available. 
+For older versions of Node.js, you can use the [`node-fetch` ](https://github.com/node-fetch/node-fetch) package.
+
+Since Node.js v18.0.0, the fetch API is available by default.
+
+In the browser fetch is generally available, and is available on the `window.fetch` object.
+You can read more about it here: [MDN Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)
+
+Other serverside Java Script runtimes such as [Bun](https://bun.sh/) and (Deno)[https://deno.com/] already have fetch available on the global `fetch` object.
+
+## `cacheImplementation`
+
+This property is used to set the cache implementation.
+There are three different cache mechanigms abailable in the EffectAI SDK.
+First of all, "IDBCache", "LocalStorageCache", "MemoryCache".
+Any of these can be passed to the `cacheImplementation` property while instanlizing the EffectAI Client.
+
+```typescript
+import { createClient, IDBCache, LocalStorageCache, MemoryCache } from '@effectai/sdk'
+const client = createClient({
+  cacheImplementation: new IDBCache() // or new LocalStorageCache() or new MemoryCache()
+})
+```
+
+# TODO:  This needs to be changed when the `dev` branch is merged into main.
+[See Type](https://github.com/effectai/effect-js/blob/main/src/client.ts)
+

docs/pages/docs/guides/createACampaign.mdx

@@ -0,0 +1,90 @@
+## Creating Your First Campaign
+
+To create a campaign, you need to have a few things in place:
+
+
+# Create and upload campaign
+
+## Usage
+
+```ts [example.ts]
+import { createClient, createCampaign } from '@effectai/effect-js'
+
+const campaign: Mkcampaign = {
+	owner: ["name", "efxefxefxefx"],
+	content: {
+		field_0: 0,
+		field_1: "QmVKwq3bYM6cPW6kstpiq4WYckWRtdfJnzAmms2iMyGqQg",
+	},
+	max_task_time: 100,
+	reward: { quantity: "42.1234, EFX", contract: "efxtoken1112" },
+	qualis: [],
+	payer: "efxefxefxefx",
+};
+
+const data = {
+	version: 1.1,
+	title: "Labelstudio OCR (LAION)",
+	description:
+		"You are contributing to a dataset for conversational style chatbots.",
+	instructions: "Some instructions here",
+	template: "<h1>Template here</h1>",
+	input_schema: null,
+	output_schema: null,
+	image: "",
+	category: "",
+	example_task: "",
+	estimated_time: 10,
+};
+
+const client = await testClientSession({ testEnvNetwork: jungle4 });
+const result = await createCampaign({ client, campaign, data });
+```
+
+## Returns
+
+Result is a transaction response object.
+
+```json
+response: {
+	transaction_id: "9d321af28b7354c5cbee6ee956ea3e6590228b48539a9f0cafc6a8ca5ffe0ca2",
+	processed: {
+		id: "9d321af28b7354c5cbee6ee956ea3e6590228b48539a9f0cafc6a8ca5ffe0ca2",
+		block_num: 137520447,
+		block_time: "2024-05-01T03:55:31.500",
+		producer_block_id: null,
+		receipt: [Object ...],
+		elapsed: 4854,
+		net_usage: 176,
+		scheduled: false,
+		action_traces: [
+		  [Object ...]
+		],
+		account_ram_delta: null,
+		except: null,
+		error_code: null,
+	},
+}
+```
+
+
+- **Type:**  [`Promise<GetTableRowsResponse<UInt128, Campaign>>`](/docs/glossary/types#campaign)
+- **Description:** A list of campaigns.
+- **Properties:**
+  - **rows:** An array of campaigns.
+  - **more:** A boolean indicating if there are more campaigns to fetch.
+  - **next_key:** A string that can be used to fetch the next page of campaigns.
+
+## Parameters
+
+### client
+- **Type:** `Client`
+
+### limit (optional) 
+- **Type:** `number`
+- **Default:** `10`
+
+### page (optional)
+- **Type:** `number`
+- **Default:** `1`
+