@ar.io/sdk 4.0.0-solana.8 → 4.0.0

package/lib/esm/solana/index.js

@@ -1,3 +1,18 @@
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 /**
  * Solana backend for the AR.IO SDK.
  *
@@ -38,9 +53,23 @@
  * });
  * ```
  */
-// ARIO protocol classes
+// Public factory classes — `ARIO.init({ rpc })` / `ANT.init({ ... })` /
+// `ANTRegistry.init({ ... })` are the primary entry points for consumers.
+// `createFaucet` wraps an ARIO instance with the HTTP faucet client.
+export * from '../common/index.js';
+// Public types (interfaces, params, pagination, etc.) shared by the SDK
+// surface and the Solana implementation.
+export * from '../types/index.js';
+// Public utility helpers (base64, json, schema validators, ANT helpers).
+export * from '../utils/index.js';
+// Top-level protocol constants. Explicit named exports to avoid colliding
+// with `./spawn-ant.js`'s `ARIO_LOGO_TX_ID` (different value used by the
+// Solana metadata builder — kept distinct on purpose).
+export { ARWEAVE_TX_REGEX, AR_IO_PROTOCOL, arweaveUri, FQDN_REGEX, MARIO_PER_ARIO, } from '../constants.js';
+// Solana implementation classes (still exported for advanced/direct usage —
+// the `ARIO` / `ANT` factories above wrap these).
 export { SolanaARIOReadable } from './io-readable.js';
-export { SolanaARIOWriteable } from './io-writeable.js';
+export { isInvalidGatewayAccountError, SolanaARIOWriteable, } from './io-writeable.js';
 // ANT classes
 export { SolanaANTReadable } from './ant-readable.js';
 export { SolanaANTWriteable } from './ant-writeable.js';
@@ -54,27 +83,39 @@ export { SolanaANTWriteable } from './ant-writeable.js';
 export { SolanaANTRegistryReadable } from './ant-registry-readable.js';
 export { SolanaANTRegistryWriteable } from './ant-registry-writeable.js';
 // ANT-escrow client (trustless multi-protocol custody — Arweave RSA-PSS / Ethereum ECDSA)
-export { ANTEscrow, TokenEscrow } from './escrow.js';
+export { ANTEscrow, TokenEscrow, 
+// Vault-claim pre-flight helpers (ADR-022 / VaultStillLocked).
+// Exported so downstream UIs can gate their Submit buttons using the
+// SAME forward CLOCK_SKEW_TOLERANCE_SECONDS buffer the SDK's
+// assertVaultClaimable throws use — keeping pre-flight and UI gates
+// in lock-step so users never see a raw on-chain error.
+assertVaultClaimable, isVaultClaimable, CLOCK_SKEW_TOLERANCE_SECONDS, } from './escrow.js';
 // Canonical claim-message helper (byte-equivalent to Rust impl)
-export { canonicalMessage, canonicalMessageV2, bytesToHexLower, } from './canonical-message.js';
+export { canonicalMessage, canonicalMessageV2, deriveRecipientId, bytesToHexLower, } from './canonical-message.js';
 // ANT spawn (mint MPL Core asset + initialize ario-ant state in one tx)
 export { spawnSolanaANT, ARIO_LOGO_TX_ID, DEFAULT_ANT_TRANSACTION_ID, } from './spawn-ant.js';
 // PDA derivation
 export { hashName, getArioConfigPDA, getBalancePDA, getVaultPDA, getVaultCounterPDA, getPrimaryNamePDA, getPrimaryNameRequestPDA, getGatewayRegistryPDA, getGarSettingsPDA, getGatewayPDA, getDelegationPDA, getWithdrawalPDA, getWithdrawalCounterPDA, getAllowlistPDA, getEpochPDA, getEpochSettingsPDA, getObservationPDA, getArnsRegistryPDA, getArnsSettingsPDA, getArnsRecordPDA, getArnsRecordPDAFromHash, getReservedNamePDA, getReturnedNamePDA, getDemandFactorPDA, getPrimaryNameReversePDA, getRedelegationRecordPDA, getAntConfigPDA, getAntControllersPDA, getAntRecordPDA, getAclConfigPDA, getAclPagePDA, getEscrowAntPDA, getEscrowTokenPDA, getEscrowVaultPDA, } from './pda.js';
-// Deserialization
+// Deserialization adapters
 //
-// NOTE: account discriminators come from the Codama-generated modules
-// under `./generated/<program>/accounts/*` (e.g. `BALANCE_DISCRIMINATOR`,
-// `ANT_RECORD_DISCRIMINATOR`). Pull them from there instead of asking
-// this module — single source of truth, derived from the IDL.
+// Thin wrappers over Codama-generated decoders from `@ar.io/solana-contracts`.
+// They accept raw `Buffer` data and return plain-object types (string/number)
+// instead of Codama's `Address`/`bigint` types, so SDK consumers don't need
+// to import the contracts package directly.
+// Account discriminators come from `@ar.io/solana-contracts/<program>`.
 export { BorshReader, BorshWriter, deserializeGateway, deserializeArnsRecord, deserializeVault, deserializeDelegation, deserializeBalance, deserializeEpochSettings, deserializeArioConfig, deserializeDemandFactor, deserializeReservedName, deserializeReturnedName, deserializeWithdrawal, deserializeRedelegationRecord, deserializePrimaryNameRequest, deserializePrimaryName, deserializeAllowlist, deserializeGarSettings, deserializeEpochSettingsFull, deserializeEpoch, deserializeObservation, deserializeAntConfig, deserializeAntControllers, deserializeAntRecord, deserializeAclConfig, deserializeAclPage, } from './deserialize.js';
+// Off-chain prediction of prescribe_epoch's observer selection (cranker helper)
+export { predictPrescribedObservers, } from './predict-prescribed-observers.js';
 // Constants
 export * from './constants.js';
 // Cluster-specific deployment constants (devnet program IDs, RPC URL,
-// mint, treasury / stake token accounts). Source of truth is
-// `/devnet-config.json` — kept in sync via the drift guard test
-// `clusters.test.ts`.
+// mint). PDAs derive from these via the codama `find*Pda` helpers; token
+// accounts are read on-chain — neither is stored here.
 export * from './clusters.js';
+// RPC circuit breaker (opossum-backed transparent fallback)
+export { createCircuitBreakerRpc, defaultFallbackUrl, } from './rpc-circuit-breaker.js';
+// Retry utility (exponential back-off for transient RPC errors)
+export { withRetry, isRetryableError } from './retry.js';
 // Event decoders
 //
 // `parseTransactionEvents(rpc, signature)` and `parseEventsFromLogs(logs)`

package/lib/esm/solana/instruction.js

@@ -1,3 +1,18 @@
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 /**
  * Common Solana program/sysvar addresses used by the SDK.
  *