Instrument methods: grant
The Instrument Verbs grant as typed SDK methods, with inputs, result, refusals and an example.
Reference for Instrument, one group of Instrument methods.
Instrument.grant
Grant gives a Holder an option from the pool, with its strike price, vesting schedule and cliff. Verb page.
interface InstrumentVerbs {
grant(input: InstrumentGrantInput, options?: SB.CallOptions): SB.Call<Instrument>
}Emits Instrument.granted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
holder | Holder | required | The Holder who receives the option, usually a Worker. |
quantity | integer | required | The Shares the option covers. |
strike | money | required | The exercise price, at or above the latest fair market value. |
vesting | json | required | The schedule and cliff. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
instrument | Instrument | required | The granted option. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
| A strike below the latest 409A fair market value | refused | Clear what the check names, then call it again. | None. |
Example
import { $ } from 'startup-builder'
const instrument = await $.Instrument.grant({ holder: 'holder_e2Dm5Y6QGO', quantity: 1, strike: { amount: 29, currency: 'USD' }, vesting: {} })