[![npm][npm-image]][npm-url]
[![npm-downloads][npm-downloads-image]][npm-url]


[![code-style-prettier][code-style-prettier-image]][code-style-prettier-url]

[code-style-prettier-image]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square
[code-style-prettier-url]: https://github.com/prettier/prettier
[npm-downloads-image]: https://img.shields.io/npm/dm/@trezoa/instructions?style=flat
[npm-image]: https://img.shields.io/npm/v/@trezoa/instructions?style=flat
[npm-url]: https://www.npmjs.com/package/@trezoa/instructions

@trezoa/instructions

This package contains types for creating transaction instructions. It can be used standalone, but it is also exported as part of Kit @trezoa/kit.

Types

$3

The purpose for which an account participates in a transaction is described by the AccountRole type. Every account that participates in a transaction can be read from, but only ones that you mark as writable may be written to, and only ones that you indicate must sign the transaction will gain the privileges associated with signers at runtime.

| | isSigner | isWritable |
| ----------------------------- | ---------- | ------------ |
| AccountRole.READONLY | ❌ | ❌ |
| AccountRole.WRITABLE | ❌ | ✅ |
| AccountRole.READONLY_SIGNER | ✅ | ❌ |
| AccountRole.WRITABLE_SIGNER | ✅ | ✅ |

$3

This type represents an account's address and metadata about its mutability and whether it must be a signer of the transaction.

Typically, you will use one of its subtypes.

| | role | isSigner | isWritable |
| --------------------------------- | ----------------------------- | ---------- | ------------ |
| ReadonlyAccount | AccountRole.READONLY | ❌ | ❌ |
| WritableAccount | AccountRole.WRITABLE | ❌ | ✅ |
| ReadonlySignerAccount | AccountRole.READONLY_SIGNER | ✅ | ❌ |
| WritableSignerAccount | AccountRole.WRITABLE_SIGNER | ✅ | ✅ |

For example, you could type the rent sysvar account like this:

``ts
type RentSysvar = ReadonlyAccount<'SysvarRent111111111111111111111111111111111'>;
`

$3

This type represents a lookup of the account's address in an address lookup table. It specifies which lookup table account in which to perform the lookup, the index of the desired account address in that table, and metadata about its mutability. Notably, account addresses obtained via lookups may not act as signers.

Typically, you will use one of its subtypes.

| | role | isSigner | isWritable |
| ------------------------------------------------------ | ---------------------- | ---------- | ------------ |
| ReadonlyLookupAccount | AccountRole.READONLY | ❌ | ❌ |
| WritableLookupAccount | AccountRole.WRITABLE | ❌ | ✅ |

For example, you could type the rent sysvar account that you looked up in a lookup table like this:

`ts
type RentSysvar = ReadonlyLookupAccount<
'SysvarRent111111111111111111111111111111111',
'MyLookupTable111111111111111111111111111111'
>;
`

$3

Use this to specify an instruction destined for a given program.

`ts
type StakeProgramInstruction = Instruction<'StakeConfig11111111111111111111111111111111'>;
`

$3

Use this type to specify an instruction that loads certain accounts.

`ts
type InstructionWithTwoAccounts = InstructionWithAccounts<
[
WritableAccount, // First account
RentSysvar, // Second account
]
>;
`

$3

Use this type to specify an instruction whose data conforms to a certain type. This is most useful when you have a branded Uint8Array that represents a particular instruction's data.

For example, here is how the AdvanceNonce instruction is typed.

`ts
type AdvanceNonceAccountInstruction<
TNonceAccountAddress extends string = string,
TNonceAuthorityAddress extends string = string,
> = Instruction<'11111111111111111111111111111111'> &
InstructionWithAccounts<
[
WritableAccount,
ReadonlyAccount<'SysvarRecentB1ockHashes11111111111111111111'>,
ReadonlySignerAccount,
]
> &
InstructionWithData;
`

Functions

$3

Returns true if the AccountRole given represents that of a signer. Also refines the TypeScript type of the supplied role.

$3

Returns true if the AccountRole given represents that of a writable account. Also refines the TypeScript type of the supplied role.

$3

Given two AccountRoles, will return the AccountRole that grants the highest privileges of both.

Example:

`ts
// Returns AccountRole.WRITABLE_SIGNER
mergeRoles(AccountRole.READONLY_SIGNER, AccountRole.WRITABLE);
`

$3

Returns an AccountRole representing the non-signer variant of the supplied role.

$3

Returns an AccountRole representing the read-only variant of the supplied role.

$3

Returns an AccountRole representing the signer variant of the supplied role.

$3

Returns an AccountRole` representing the writable variant of the supplied role.