# Quick Start

### Installation

The SDK is available as a NPM package. Install using

```jsx
yarn add @charged-particles/sdk

npm install @charged-particles/sdk
```

### Getting started

```jsx
// Node
import Charged from '@charged-particles/sdk'

// Creating a signer. This is optional, used for making transactions.
const wallet = ethers.wallet.fromMnemonic(seedPhrase);

// Multiple providers array
const mySpecialProviders = [
	{
		network: 1,
		service: { 
			'alchemy': 'apiKey',
		},
	},
	{
		network: 42,
		service: {
			'rpcUrl': '<https://eth-kovan.alchemyapi.io/v2/><key>'
		}
	}
];
const charged = new Charged({providers: mySpecialProviders, signer: wallet});

// Ethers
const ethersProvider = ethers.getDefaultProvider();
const charged = new Charged({providers: ethersProvider, signer: wallet});

// Web3
var web3 = new Web3('<http://localhost:8545>');
const charged = new Charged({providers: ethersProvider, signer: wallet});
```

```jsx
// Web
import Charged from '@charged-particles/sdk'

const charged = new Charged({providers: window.ethereum});
```

*Be careful not to keep your secrets, or private key in clear text !*

### Configuration

Charged class object constructor config parameter.

```jsx
{
	sdk: { 
		// checks that signer network matches respective contract
		NftBridgeCheck: false 
	},
	transactionOverride: { 
		from: ''
		value: '' 
		gasPrice: '' 
		gasLimit: ''
		blockTag: ''
		nonce:  ''
	}
}
```

### Interacting with the protocol

When reading and/or writing you will need to define which NFT you are working with.

```jsx
/*
Before you call any functions on a specific particle, you'll need to specify 
which one you are going to work with.
*/

const contractAddress = '0x1234';
const tokenId = 33;

const nft = charged.NFT(contractAddress, tokenId);

// This energizes our nft with 47 DAI tokens.
const txReciept = await nft.energize(
    'aave.B',
    '0xDAI',
    ethers.utils.parseEther('47')
);

// Get the energized mass
const massBN = await nft.getMass('aave.B', '0xDAI');

// Discharges all of the interest accrued by the DAI tokens to my wallet.
const txReceipt2 = await nft.discharge('0xMYADDRESS', 'aave.B', '0xDAI');
```

### Utilities

The SDK provides a set of utility functions. The example below shows the format that all the functions are called by.

```jsx
// This will fetch the addresses of a contract associated with the main contract
const stateAddress = await charged.utils.getStateAddress()
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.charged.fi/sdk/quick-start.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.