# kit

## Index

### Classes

* [ContractKit](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/classes/_kit_.contractkit)

### Interfaces

* [KitOptions](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/interfaces/_kit_.kitoptions)
* [NetworkConfig](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/interfaces/_kit_.networkconfig)

### Functions

* [newKit](#newkit)
* [newKitFromWeb3](#newkitfromweb3)

## Functions

### newKit

▸ **newKit**(`url`: string, `wallet?`: [ReadOnlyWallet](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/interfaces/_wallets_wallet_.readonlywallet)): [*ContractKit*](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/classes/_kit_.contractkit)*‹›*

*Defined in* [*packages/contractkit/src/kit.ts:39*](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/kit.ts#L39)

Creates a new instance of `ContractKit` give a nodeUrl

**`optional`** wallet to reuse or add a wallet different that the default (example ledger-wallet)

**Parameters:**

| Name      | Type                                                                                                                     | Description             |
| --------- | ------------------------------------------------------------------------------------------------------------------------ | ----------------------- |
| `url`     | string                                                                                                                   | CeloBlockchain node url |
| `wallet?` | [ReadOnlyWallet](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/interfaces/_wallets_wallet_.readonlywallet) | -                       |

**Returns:** [*ContractKit*](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/classes/_kit_.contractkit)*‹›*

### newKitFromWeb3

▸ **newKitFromWeb3**(`web3`: Web3, `wallet?`: [ReadOnlyWallet](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/interfaces/_wallets_wallet_.readonlywallet)): [*ContractKit*](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/classes/_kit_.contractkit)*‹›*

*Defined in* [*packages/contractkit/src/kit.ts:51*](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/kit.ts#L51)

Creates a new instance of `ContractKit` give a web3 instance

**`optional`** wallet to reuse or add a wallet different that the default (example ledger-wallet)

**Parameters:**

| Name      | Type                                                                                                                     | Description   |
| --------- | ------------------------------------------------------------------------------------------------------------------------ | ------------- |
| `web3`    | Web3                                                                                                                     | Web3 instance |
| `wallet?` | [ReadOnlyWallet](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/interfaces/_wallets_wallet_.readonlywallet) | -             |

**Returns:** [*ContractKit*](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/classes/_kit_.contractkit)*‹›*