# @tatumio/hello-world

> Tatum JS SDK extension example

Latest version **1.0.5** (published 2023-09-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install @tatumio/hello-world
pnpm add @tatumio/hello-world
yarn add @tatumio/hello-world
bun add @tatumio/hello-world
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2023-09-28 |
| First published | 2023-09-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=18.0.0 |
| Dependencies | 0 |
| Unpacked size | 8.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Tatum |
| Maintainers | smrecz, npwork.tatum, sramkos, hathoriel |

## Links

- npm: https://www.npmjs.com/package/@tatumio/hello-world
- Repository: https://github.com/tatumio/ecosystem-addons/blob/master/examples/hello-world/README.md
- npm.io page: https://npm.io/package/@tatumio/hello-world

## Recent versions

- 1.0.5 (latest) — 2023-09-28
- 1.0.4 — 2023-09-28
- 1.0.3 — 2023-09-27
- 1.0.2 — 2023-09-27

## README

# 🌍 Hello World Extension

The Hello World Extension serves as a foundational example for extension use cases.

## 📖 Description

The Hello World Extension offers a singular method:

- `sayHello()`: This method displays a welcome message and the base fee for Ethereum.

This extension is exclusively compatible with `Ethereum`, a constraint ensured by the validation within its `init()` method.

## 🚀 Quick Start

Install the package in your application that is using `@tatumio/tatum` SDK already in a way of your choice, e.g.:

`npm install @tatumio/hello-world`

OR

`yarn add @tatumio/hello-world`

## 🛠️ How to Use

In your application, utilize the extension as depicted below:

```typescript
const tatumSdk = await TatumSDK.init<Ethereum>({
  network: Network.ETHEREUM_SEPOLIA,
  version: ApiVersion.V3,
  configureExtensions: [
    HelloWorldExtension,
  ]
})

await tatumSdk.extension(HelloWorldExtension).sayHello()
```

### 🖨️ Output

```
[HelloWorldExtension] initialised
[HelloWorldExtension] Hello World
[HelloWorldExtension] Getting network from TatumSDK configuration: ethereum-sepolia
[HelloWorldExtension] Getting base fee for the network from TatumSDK FeeEvm module: 10.735841739
[HelloWorldExtension] Base Fee for ethereum-sepolia is 10.735841739
[HelloWorldExtension] disposed
```

## 📦 @tatumio/tatum Package

The Tatum SDK package should be set as a dev dependency within the extension.

---
_Source: https://npm.io/package/@tatumio/hello-world · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._