# Linear Vesting Wallet

Creates a Wallet that allows the holder to claim coins linearly.

## Structs

### <mark style="color:blue;">**Wallet**</mark>

```rust
  struct Wallet<phantom T> has key, store {
    id: UID,
    balance: Balance<T>,
    start: u64,
    released: u64,
    duration: u64
  }
```

* **balance** - Amount of tokens to give to the holder of the wallet.&#x20;
* **start** - The holder can start claiming tokens after this date.
* **released -** Total amount of \`Coin\<T>\` released so far.&#x20;
* **duration -** The duration of the vesting.

## Interface

### <mark style="color:blue;">new</mark>

**It creates a new Wallet.**

```rust
public fun new<T>(token: Coin<T>, c: &Clock, start: u64, duration: u64, ctx: &mut TxContext): Wallet<T>
```

* **@param token:** A `sui::coin::Coin<T>`.
* **@param c:** The shared object `sui::clock::Clock`
* **@param start:** Dictate when the vesting schedule starts.
* **@param duration**: Dictate when the vesting schedule starts.
* **@return** Wallet.

**Aborts**

* `start` is in the past.

### <mark style="color:blue;">balance</mark>

**Returns the current amount of tokens in the `self`.**

```rust
public fun balance<T>(self: &Wallet<T>): u64
```

* **@param self:** A Wallet.
* **@return** u64.

### <mark style="color:blue;">start</mark>

**Returns the vesting schedule start time.**&#x20;

```rust
public fun start<T>(self: &Wallet<T>): u64
```

* **@param self:** A Wallet.
* **@return** u64.

### <mark style="color:blue;">released</mark>

**Returns the current amount of total released tokens from the `self`.**

```rust
public fun released<T>(self: &Wallet<T>): u64
```

* **@param self:** A Wallet.
* **@return** u64.

### <mark style="color:blue;">duration</mark>

**Returns the duration of the vesting schedule.**

```rust
public fun duration<T>(self: &Wallet<T>): u64
```

* **@param self:** A Wallet.
* **@return** u64.

### <mark style="color:blue;">vesting\_status</mark>

**Returns the current amount of coins available to the caller based on the linear schedule.**

```rust
public fun vesting_status<T>(self: &Wallet<T>, c: &Clock): u64
```

* **@param self:** A Wallet.
* **@param c:**  The `sui::clock::Clock` shared object.
* **@return** u64. A portion of the amount that can be claimed by the user.

### <mark style="color:blue;">claim</mark>

**Releases the current amount of coins available to the caller based on the linear schedule.**

```rust
public fun claim<T>(self: &mut Wallet<T>, c: &Clock, ctx: &mut TxContext): Coin<T>
```

* **@param self:** A Wallet.
* **@param c:** The `sui::clock::Clock` shared object.
* **@return** Coin.

### <mark style="color:blue;">destroy\_zero</mark>

**Destroys a Wallet with no balance.**

```rust
public fun destroy_zero<T>(self: Wallet<T>)
```

* **@param self:** A Wallet.