@ar.io/sdk 3.24.0 → 4.0.0-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +682 -600
- package/lib/esm/cli/cli.js +188 -152
- package/lib/esm/cli/commands/antCommands.js +23 -58
- package/lib/esm/cli/commands/arnsPurchaseCommands.js +48 -30
- package/lib/esm/cli/commands/escrowCommands.js +221 -0
- package/lib/esm/cli/commands/gatewayWriteCommands.js +142 -23
- package/lib/esm/cli/commands/pruneCommands.js +150 -0
- package/lib/esm/cli/commands/readCommands.js +22 -3
- package/lib/esm/cli/commands/transfer.js +6 -6
- package/lib/esm/cli/options.js +124 -58
- package/lib/esm/cli/utils.js +280 -174
- package/lib/esm/common/ant-registry.js +17 -143
- package/lib/esm/common/ant.js +44 -1167
- package/lib/esm/common/faucet.js +11 -6
- package/lib/esm/common/index.js +0 -4
- package/lib/esm/common/io.js +25 -1412
- package/lib/esm/constants.js +13 -19
- package/lib/esm/solana/ant-readable.js +724 -0
- package/lib/esm/solana/ant-registry-readable.js +133 -0
- package/lib/esm/solana/ant-registry-writeable.js +472 -0
- package/lib/esm/solana/ant-writeable.js +384 -0
- package/lib/esm/solana/ata.js +70 -0
- package/lib/esm/solana/canonical-message.js +128 -0
- package/lib/esm/solana/clusters.js +111 -0
- package/lib/esm/solana/constants.js +146 -0
- package/lib/esm/solana/delegation-math.js +112 -0
- package/lib/esm/solana/deserialize.js +711 -0
- package/lib/esm/solana/escrow.js +839 -0
- package/lib/{cjs/utils/json.js → esm/solana/events.js} +15 -10
- package/lib/esm/solana/funding-plan.js +699 -0
- package/lib/esm/solana/index.js +126 -0
- package/lib/esm/solana/instruction.js +39 -0
- package/lib/esm/solana/io-readable.js +2182 -0
- package/lib/esm/solana/io-writeable.js +3196 -0
- package/lib/esm/solana/json-rpc.js +90 -0
- package/lib/esm/solana/metadata.js +81 -0
- package/lib/esm/solana/mpl-core.js +192 -0
- package/lib/esm/solana/pda.js +332 -0
- package/lib/esm/solana/predict-prescribed-observers.js +110 -0
- package/lib/esm/solana/retry.js +117 -0
- package/lib/esm/solana/rpc-circuit-breaker.js +258 -0
- package/lib/esm/solana/send.js +372 -0
- package/lib/esm/solana/spawn-ant.js +224 -0
- package/lib/esm/solana/types.js +1 -0
- package/lib/esm/types/ant.js +27 -15
- package/lib/esm/types/io.js +8 -11
- package/lib/esm/utils/ant.js +0 -63
- package/lib/esm/utils/index.js +0 -3
- package/lib/esm/version.js +1 -1
- package/lib/types/cli/commands/antCommands.d.ts +5 -13
- package/lib/types/cli/commands/arnsPurchaseCommands.d.ts +33 -7
- package/lib/types/cli/commands/escrowCommands.d.ts +68 -0
- package/lib/types/cli/commands/gatewayWriteCommands.d.ts +12 -11
- package/lib/types/cli/commands/pruneCommands.d.ts +31 -0
- package/lib/types/cli/commands/readCommands.d.ts +27 -22
- package/lib/types/cli/commands/transfer.d.ts +9 -9
- package/lib/types/cli/options.d.ts +76 -21
- package/lib/types/cli/types.d.ts +11 -13
- package/lib/types/cli/utils.d.ts +71 -31
- package/lib/types/common/ant-registry.d.ts +49 -47
- package/lib/types/common/ant.d.ts +54 -539
- package/lib/types/common/faucet.d.ts +20 -8
- package/lib/types/common/index.d.ts +0 -3
- package/lib/types/common/io.d.ts +51 -263
- package/lib/types/constants.d.ts +11 -18
- package/lib/types/solana/ant-readable.d.ts +180 -0
- package/lib/types/solana/ant-registry-readable.d.ts +105 -0
- package/lib/types/solana/ant-registry-writeable.d.ts +249 -0
- package/lib/types/solana/ant-writeable.d.ts +177 -0
- package/lib/types/solana/ata.d.ts +44 -0
- package/lib/types/solana/canonical-message.d.ts +121 -0
- package/lib/types/solana/clusters.d.ts +109 -0
- package/lib/types/solana/constants.d.ts +119 -0
- package/lib/types/solana/delegation-math.d.ts +45 -0
- package/lib/types/solana/deserialize.d.ts +262 -0
- package/lib/types/solana/escrow.d.ts +480 -0
- package/lib/types/solana/events.d.ts +38 -0
- package/lib/types/solana/funding-plan.d.ts +225 -0
- package/lib/types/solana/index.d.ts +87 -0
- package/lib/types/solana/instruction.d.ts +39 -0
- package/lib/types/solana/io-readable.d.ts +499 -0
- package/lib/types/solana/io-writeable.d.ts +893 -0
- package/lib/types/solana/json-rpc.d.ts +47 -0
- package/lib/types/solana/metadata.d.ts +84 -0
- package/lib/types/solana/mpl-core.d.ts +120 -0
- package/lib/types/solana/pda.d.ts +95 -0
- package/lib/types/solana/predict-prescribed-observers.d.ts +28 -0
- package/lib/types/solana/retry.d.ts +62 -0
- package/lib/types/solana/rpc-circuit-breaker.d.ts +78 -0
- package/lib/types/solana/send.d.ts +94 -0
- package/lib/types/solana/spawn-ant.d.ts +145 -0
- package/lib/types/solana/types.d.ts +82 -0
- package/lib/types/types/ant-registry.d.ts +43 -4
- package/lib/types/types/ant.d.ts +114 -96
- package/lib/types/types/common.d.ts +18 -74
- package/lib/types/types/faucet.d.ts +2 -2
- package/lib/types/types/io.d.ts +244 -158
- package/lib/types/types/token.d.ts +0 -12
- package/lib/types/utils/ant.d.ts +1 -12
- package/lib/types/utils/index.d.ts +0 -3
- package/lib/types/version.d.ts +1 -1
- package/package.json +36 -33
- package/lib/cjs/cli/cli.js +0 -822
- package/lib/cjs/cli/commands/antCommands.js +0 -113
- package/lib/cjs/cli/commands/arnsPurchaseCommands.js +0 -212
- package/lib/cjs/cli/commands/gatewayWriteCommands.js +0 -210
- package/lib/cjs/cli/commands/readCommands.js +0 -215
- package/lib/cjs/cli/commands/transfer.js +0 -159
- package/lib/cjs/cli/options.js +0 -470
- package/lib/cjs/cli/types.js +0 -2
- package/lib/cjs/cli/utils.js +0 -639
- package/lib/cjs/common/ant-registry.js +0 -155
- package/lib/cjs/common/ant-versions.js +0 -93
- package/lib/cjs/common/ant.js +0 -1182
- package/lib/cjs/common/arweave.js +0 -27
- package/lib/cjs/common/contracts/ao-process.js +0 -224
- package/lib/cjs/common/error.js +0 -64
- package/lib/cjs/common/faucet.js +0 -150
- package/lib/cjs/common/hyperbeam/hb.js +0 -173
- package/lib/cjs/common/index.js +0 -42
- package/lib/cjs/common/io.js +0 -1423
- package/lib/cjs/common/logger.js +0 -83
- package/lib/cjs/common/loggers/winston.js +0 -68
- package/lib/cjs/common/marketplace.js +0 -731
- package/lib/cjs/common/turbo.js +0 -223
- package/lib/cjs/constants.js +0 -41
- package/lib/cjs/node/index.js +0 -39
- package/lib/cjs/package.json +0 -1
- package/lib/cjs/types/ant-registry.js +0 -2
- package/lib/cjs/types/ant.js +0 -168
- package/lib/cjs/types/common.js +0 -2
- package/lib/cjs/types/faucet.js +0 -2
- package/lib/cjs/types/index.js +0 -37
- package/lib/cjs/types/io.js +0 -51
- package/lib/cjs/types/token.js +0 -116
- package/lib/cjs/utils/ant.js +0 -108
- package/lib/cjs/utils/ao.js +0 -432
- package/lib/cjs/utils/arweave.js +0 -285
- package/lib/cjs/utils/base64.js +0 -62
- package/lib/cjs/utils/hash.js +0 -56
- package/lib/cjs/utils/index.js +0 -38
- package/lib/cjs/utils/processes.js +0 -173
- package/lib/cjs/utils/random.js +0 -30
- package/lib/cjs/utils/schema.js +0 -15
- package/lib/cjs/utils/url.js +0 -37
- package/lib/cjs/version.js +0 -20
- package/lib/cjs/web/index.js +0 -41
- package/lib/esm/common/ant-versions.js +0 -87
- package/lib/esm/common/arweave.js +0 -21
- package/lib/esm/common/contracts/ao-process.js +0 -220
- package/lib/esm/common/hyperbeam/hb.js +0 -169
- package/lib/esm/common/marketplace.js +0 -724
- package/lib/esm/common/turbo.js +0 -215
- package/lib/esm/node/index.js +0 -20
- package/lib/esm/utils/ao.js +0 -420
- package/lib/esm/utils/arweave.js +0 -271
- package/lib/esm/utils/processes.js +0 -167
- package/lib/esm/web/index.js +0 -20
- package/lib/types/common/ant-versions.d.ts +0 -39
- package/lib/types/common/arweave.d.ts +0 -17
- package/lib/types/common/contracts/ao-process.d.ts +0 -47
- package/lib/types/common/hyperbeam/hb.d.ts +0 -88
- package/lib/types/common/marketplace.d.ts +0 -568
- package/lib/types/common/turbo.d.ts +0 -61
- package/lib/types/node/index.d.ts +0 -20
- package/lib/types/utils/ao.d.ts +0 -80
- package/lib/types/utils/arweave.d.ts +0 -79
- package/lib/types/utils/processes.d.ts +0 -39
- package/lib/types/web/index.d.ts +0 -20
|
@@ -1,149 +1,23 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
|
|
3
|
-
*
|
|
4
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
-
* you may not use this file except in compliance with the License.
|
|
6
|
-
* You may obtain a copy of the License at
|
|
7
|
-
*
|
|
8
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
-
*
|
|
10
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
-
* See the License for the specific language governing permissions and
|
|
14
|
-
* limitations under the License.
|
|
15
|
-
*/
|
|
16
|
-
import { ANT_REGISTRY_ID } from '../constants.js';
|
|
17
|
-
import { isProcessConfiguration, isProcessIdConfiguration, } from '../types/index.js';
|
|
18
|
-
import { createAoSigner } from '../utils/ao.js';
|
|
19
|
-
import { AOProcess, InvalidContractConfigurationError } from './index.js';
|
|
20
|
-
import { Logger } from './logger.js';
|
|
21
1
|
export class ANTRegistry {
|
|
22
2
|
static init(config) {
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
logger;
|
|
34
|
-
constructor(config) {
|
|
35
|
-
this.logger = config?.logger ?? Logger.default;
|
|
36
|
-
if (config === undefined || Object.keys(config).length === 0) {
|
|
37
|
-
this.process = new AOProcess({
|
|
38
|
-
processId: ANT_REGISTRY_ID,
|
|
39
|
-
});
|
|
40
|
-
}
|
|
41
|
-
else if (isProcessConfiguration(config)) {
|
|
42
|
-
this.process = config.process;
|
|
43
|
-
}
|
|
44
|
-
else if (isProcessIdConfiguration(config)) {
|
|
45
|
-
this.process = new AOProcess({
|
|
46
|
-
processId: config.processId,
|
|
47
|
-
});
|
|
48
|
-
}
|
|
49
|
-
else {
|
|
50
|
-
throw new InvalidContractConfigurationError();
|
|
51
|
-
}
|
|
52
|
-
if (config?.hyperbeamUrl !== undefined) {
|
|
53
|
-
this.hyperbeamUrl = new URL(config.hyperbeamUrl).toString();
|
|
54
|
-
this.checkHyperBeamPromise = this.checkHyperBeamCompatibility();
|
|
55
|
-
}
|
|
56
|
-
}
|
|
57
|
-
/**
|
|
58
|
-
* Check if the process is HyperBeam compatible. If so, we'll use the HyperBeam node to fetch the state.
|
|
59
|
-
*
|
|
60
|
-
* @returns {Promise<boolean>} True if the process is HyperBeam compatible, false otherwise.
|
|
61
|
-
*/
|
|
62
|
-
async checkHyperBeamCompatibility() {
|
|
63
|
-
if (this.hyperbeamUrl === undefined) {
|
|
64
|
-
return Promise.resolve(false);
|
|
65
|
-
}
|
|
66
|
-
if (this.checkHyperBeamPromise !== undefined) {
|
|
67
|
-
return this.checkHyperBeamPromise;
|
|
68
|
-
}
|
|
69
|
-
this.logger.debug('Checking HyperBeam compatibility');
|
|
70
|
-
this.checkHyperBeamPromise = fetch(
|
|
71
|
-
// use /now to force a refresh of the cache state, then compute when calling it for keys
|
|
72
|
-
`${this.hyperbeamUrl.toString()}${this.process.processId}~process@1.0/now/cache/acl`, {
|
|
73
|
-
method: 'HEAD',
|
|
74
|
-
signal: AbortSignal.timeout(5000), // 5 second timeout
|
|
75
|
-
})
|
|
76
|
-
.then((res) => {
|
|
77
|
-
if (res.ok) {
|
|
78
|
-
this.logger.debug('HyperBeam compatible');
|
|
79
|
-
return true;
|
|
3
|
+
return (async () => {
|
|
4
|
+
if ('signer' in config) {
|
|
5
|
+
const { SolanaANTRegistryWriteable } = await import('../solana/ant-registry-writeable.js');
|
|
6
|
+
return new SolanaANTRegistryWriteable({
|
|
7
|
+
rpc: config.rpc,
|
|
8
|
+
signer: config.signer,
|
|
9
|
+
commitment: config.commitment,
|
|
10
|
+
logger: config.logger,
|
|
11
|
+
antProgramId: config.antProgramId,
|
|
12
|
+
});
|
|
80
13
|
}
|
|
81
|
-
|
|
82
|
-
return
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
14
|
+
const { SolanaANTRegistryReadable } = await import('../solana/ant-registry-readable.js');
|
|
15
|
+
return new SolanaANTRegistryReadable({
|
|
16
|
+
rpc: config.rpc,
|
|
17
|
+
commitment: config.commitment,
|
|
18
|
+
logger: config.logger,
|
|
19
|
+
antProgramId: config.antProgramId,
|
|
87
20
|
});
|
|
88
|
-
|
|
89
|
-
});
|
|
90
|
-
return this.checkHyperBeamPromise;
|
|
91
|
-
}
|
|
92
|
-
// Should we rename this to "getANTsByAddress"? seems more clear, though not same as handler name
|
|
93
|
-
async accessControlList({ address, }) {
|
|
94
|
-
if (await this.checkHyperBeamCompatibility()) {
|
|
95
|
-
let retries = 0;
|
|
96
|
-
while (retries < 3) {
|
|
97
|
-
try {
|
|
98
|
-
this.logger.debug('Fetching ant registry acl for address from hyperbeam', address);
|
|
99
|
-
const res = await fetch(`${this.hyperbeamUrl?.toString()}${this.process.processId}~process@1.0/compute/cache/acl/${address}/serialize~json@1.0`);
|
|
100
|
-
if (res.status !== 200) {
|
|
101
|
-
this.logger.debug('Failed to fetch ant registry acl for address from hyperbeam', address, res.status, res.statusText);
|
|
102
|
-
throw new Error(`Failed to fetch ant registry acl for address ${address}: ${res?.statusText ?? 'Unknown error'}`);
|
|
103
|
-
}
|
|
104
|
-
this.logger.debug('Fetched ant registry acl for address from hyperbeam', address);
|
|
105
|
-
const json = (await res.json());
|
|
106
|
-
return {
|
|
107
|
-
Owned: json.Owned,
|
|
108
|
-
Controlled: json.Controlled,
|
|
109
|
-
};
|
|
110
|
-
}
|
|
111
|
-
catch (_error) {
|
|
112
|
-
retries++;
|
|
113
|
-
this.logger.debug('Failed to fetch ant registry acl for address from hyperbeam', address, retries);
|
|
114
|
-
await new Promise((resolve) => setTimeout(resolve, 1000 * retries ** 2));
|
|
115
|
-
}
|
|
116
|
-
}
|
|
117
|
-
}
|
|
118
|
-
this.logger.debug('Fetching ant registry acl for address from process', address);
|
|
119
|
-
return this.process.read({
|
|
120
|
-
tags: [
|
|
121
|
-
{ name: 'Action', value: 'Access-Control-List' },
|
|
122
|
-
{ name: 'Address', value: address },
|
|
123
|
-
],
|
|
124
|
-
});
|
|
125
|
-
}
|
|
126
|
-
/*
|
|
127
|
-
* This is the same as accessControlList, but with a cleaner DX to make it clearer
|
|
128
|
-
* that we're fetching the list of ANTs owned or controlled by an address.
|
|
129
|
-
*/
|
|
130
|
-
async getAntsForAddress({ address, }) {
|
|
131
|
-
return this.accessControlList({ address });
|
|
132
|
-
}
|
|
133
|
-
}
|
|
134
|
-
export class AoANTRegistryWriteable extends AoANTRegistryReadable {
|
|
135
|
-
signer;
|
|
136
|
-
constructor({ signer, ...config }) {
|
|
137
|
-
super(config);
|
|
138
|
-
this.signer = createAoSigner(signer);
|
|
139
|
-
}
|
|
140
|
-
async register({ processId, }) {
|
|
141
|
-
return this.process.send({
|
|
142
|
-
tags: [
|
|
143
|
-
{ name: 'Action', value: 'Register' },
|
|
144
|
-
{ name: 'Process-Id', value: processId },
|
|
145
|
-
],
|
|
146
|
-
signer: this.signer,
|
|
147
|
-
});
|
|
21
|
+
})();
|
|
148
22
|
}
|
|
149
23
|
}
|