-
Notifications
You must be signed in to change notification settings - Fork 511
/
Edition.ts
161 lines (148 loc) · 4.59 KB
/
Edition.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
/**
* This code was GENERATED using the solita package.
* Please DO NOT EDIT THIS FILE, instead rerun solita to update it or write a wrapper to add functionality.
*
* See: https://github.com/metaplex-foundation/solita
*/
import * as web3 from '@solana/web3.js';
import * as beet from '@metaplex-foundation/beet';
import * as beetSolana from '@metaplex-foundation/beet-solana';
import { Key, keyBeet } from '../types/Key';
/**
* Arguments used to create {@link Edition}
* @category Accounts
* @category generated
*/
export type EditionArgs = {
key: Key;
parent: web3.PublicKey;
edition: beet.bignum;
};
/**
* Holds the data for the {@link Edition} Account and provides de/serialization
* functionality for that data
*
* @category Accounts
* @category generated
*/
export class Edition implements EditionArgs {
private constructor(
readonly key: Key,
readonly parent: web3.PublicKey,
readonly edition: beet.bignum,
) {}
/**
* Creates a {@link Edition} instance from the provided args.
*/
static fromArgs(args: EditionArgs) {
return new Edition(args.key, args.parent, args.edition);
}
/**
* Deserializes the {@link Edition} from the data of the provided {@link web3.AccountInfo}.
* @returns a tuple of the account data and the offset up to which the buffer was read to obtain it.
*/
static fromAccountInfo(accountInfo: web3.AccountInfo<Buffer>, offset = 0): [Edition, number] {
return Edition.deserialize(accountInfo.data, offset);
}
/**
* Retrieves the account info from the provided address and deserializes
* the {@link Edition} from its data.
*
* @throws Error if no account info is found at the address or if deserialization fails
*/
static async fromAccountAddress(
connection: web3.Connection,
address: web3.PublicKey,
): Promise<Edition> {
const accountInfo = await connection.getAccountInfo(address);
if (accountInfo == null) {
throw new Error(`Unable to find Edition account at ${address}`);
}
return Edition.fromAccountInfo(accountInfo, 0)[0];
}
/**
* Provides a {@link web3.Connection.getProgramAccounts} config builder,
* to fetch accounts matching filters that can be specified via that builder.
*
* @param programId - the program that owns the accounts we are filtering
*/
static gpaBuilder(
programId: web3.PublicKey = new web3.PublicKey('metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s'),
) {
return beetSolana.GpaBuilder.fromStruct(programId, editionBeet);
}
/**
* Deserializes the {@link Edition} from the provided data Buffer.
* @returns a tuple of the account data and the offset up to which the buffer was read to obtain it.
*/
static deserialize(buf: Buffer, offset = 0): [Edition, number] {
return editionBeet.deserialize(buf, offset);
}
/**
* Serializes the {@link Edition} into a Buffer.
* @returns a tuple of the created Buffer and the offset up to which the buffer was written to store it.
*/
serialize(): [Buffer, number] {
return editionBeet.serialize(this);
}
/**
* Returns the byteSize of a {@link Buffer} holding the serialized data of
* {@link Edition}
*/
static get byteSize() {
return editionBeet.byteSize;
}
/**
* Fetches the minimum balance needed to exempt an account holding
* {@link Edition} data from rent
*
* @param connection used to retrieve the rent exemption information
*/
static async getMinimumBalanceForRentExemption(
connection: web3.Connection,
commitment?: web3.Commitment,
): Promise<number> {
return connection.getMinimumBalanceForRentExemption(Edition.byteSize, commitment);
}
/**
* Determines if the provided {@link Buffer} has the correct byte size to
* hold {@link Edition} data.
*/
static hasCorrectByteSize(buf: Buffer, offset = 0) {
return buf.byteLength - offset === Edition.byteSize;
}
/**
* Returns a readable version of {@link Edition} properties
* and can be used to convert to JSON and/or logging
*/
pretty() {
return {
key: 'Key.' + Key[this.key],
parent: this.parent.toBase58(),
edition: (() => {
const x = <{ toNumber: () => number }>this.edition;
if (typeof x.toNumber === 'function') {
try {
return x.toNumber();
} catch (_) {
return x;
}
}
return x;
})(),
};
}
}
/**
* @category Accounts
* @category generated
*/
export const editionBeet = new beet.BeetStruct<Edition, EditionArgs>(
[
['key', keyBeet],
['parent', beetSolana.publicKey],
['edition', beet.u64],
],
Edition.fromArgs,
'Edition',
);