@ar.io/sdk 1.2.0-alpha.11 → 1.2.0-alpha.13

package/lib/esm/common/io.js

@@ -66,11 +66,11 @@ export class IOReadable {
                 value: epoch.timestamp?.toString() ?? '',
             },
             {
-                name: 'BlockHeight',
+                name: 'Block-Height',
                 value: epoch?.blockHeight?.toString(),
             },
             {
-                name: 'EpochIndex',
+                name: 'Epoch-Index',
                 value: epoch?.epochIndex?.toString(),
             },
         ];
@@ -101,13 +101,13 @@ export class IOReadable {
     }
     async getArNSReservedNames() {
         return this.process.read({
-            tags: [{ name: 'Action', value: 'ReservedNames' }],
+            tags: [{ name: 'Action', value: 'Reserved-Names' }],
         });
     }
     async getArNSReservedName({ name, }) {
         return this.process.read({
             tags: [
-                { name: 'Action', value: 'ReservedName' },
+                { name: 'Action', value: 'Reserved-Name' },
                 { name: 'Name', value: name },
             ],
         });
@@ -148,17 +148,17 @@ export class IOReadable {
     }
     async getPrescribedObservers(epoch) {
         const allTags = [
-            { name: 'Action', value: 'EpochPrescribedObservers' },
+            { name: 'Action', value: 'Epoch-Prescribed-Observers' },
             {
                 name: 'Timestamp',
                 value: epoch.timestamp?.toString(),
             },
             {
-                name: 'BlockHeight',
+                name: 'Block-Height',
                 value: epoch?.blockHeight?.toString(),
             },
             {
-                name: 'EpochIndex',
+                name: 'Epoch-Index',
                 value: epoch?.epochIndex?.toString(),
             },
         ];
@@ -176,17 +176,17 @@ export class IOReadable {
     }
     async getPrescribedNames(epoch) {
         const allTags = [
-            { name: 'Action', value: 'EpochPrescribedNames' },
+            { name: 'Action', value: 'Epoch-Prescribed-Names' },
             {
                 name: 'Timestamp',
                 value: epoch.timestamp?.toString(),
             },
             {
-                name: 'BlockHeight',
+                name: 'Block-Height',
                 value: epoch?.blockHeight?.toString(),
             },
             {
-                name: 'EpochIndex',
+                name: 'Epoch-Index',
                 value: epoch?.epochIndex?.toString(),
             },
         ];
@@ -204,17 +204,17 @@ export class IOReadable {
     }
     async getObservations(epoch) {
         const allTags = [
-            { name: 'Action', value: 'EpochObservations' },
+            { name: 'Action', value: 'Epoch-Observations' },
             {
                 name: 'Timestamp',
                 value: epoch.timestamp?.toString(),
             },
             {
-                name: 'BlockHeight',
+                name: 'Block-Height',
                 value: epoch?.blockHeight?.toString(),
             },
             {
-                name: 'EpochIndex',
+                name: 'Epoch-Index',
                 value: epoch?.epochIndex?.toString(),
             },
         ];
@@ -232,17 +232,17 @@ export class IOReadable {
     }
     async getDistributions(epoch) {
         const allTags = [
-            { name: 'Action', value: 'EpochDistributions' },
+            { name: 'Action', value: 'Epoch-Distributions' },
             {
                 name: 'Timestamp',
                 value: epoch.timestamp?.toString() ?? '',
             },
             {
-                name: 'BlockHeight',
+                name: 'Block-Height',
                 value: epoch?.blockHeight?.toString(),
             },
             {
-                name: 'EpochIndex',
+                name: 'Epoch-Index',
                 value: epoch?.epochIndex?.toString(),
             },
         ];
@@ -260,7 +260,7 @@ export class IOReadable {
     }
     async getTokenCost({ intent, purchaseType, years, name, quantity, }) {
         const allTags = [
-            { name: 'Action', value: 'TokenCost' },
+            { name: 'Action', value: 'Token-Cost' },
             {
                 name: 'Intent',
                 value: intent,
@@ -278,7 +278,7 @@ export class IOReadable {
                 value: quantity?.toString(),
             },
             {
-                name: 'PurchaseType',
+                name: 'Purchase-Type',
                 value: purchaseType,
             },
         ];
@@ -337,17 +337,17 @@ export class IOWriteable extends IOReadable {
         const { tags = [] } = options || {};
         const allTags = [
             ...tags,
-            { name: 'Action', value: 'JoinNetwork' },
+            { name: 'Action', value: 'Join-Network' },
             {
-                name: 'OperatorStake',
+                name: 'Operator-Stake',
                 value: operatorStake.valueOf().toString(),
             },
             {
-                name: 'AllowDelegatedStaking',
+                name: 'Allow-Delegated-Staking',
                 value: allowDelegatedStaking.toString(),
             },
             {
-                name: 'DelegateRewardShareRatio',
+                name: 'Delegate-Reward-Share-Ratio',
                 value: delegateRewardShareRatio.toString(),
             },
             {
@@ -359,7 +359,7 @@ export class IOWriteable extends IOReadable {
                 value: label,
             },
             {
-                name: 'MinDelegatedStake',
+                name: 'Min-Delegated-Stake',
                 value: minDelegatedStake.valueOf().toString(),
             },
             {
@@ -379,11 +379,11 @@ export class IOWriteable extends IOReadable {
                 value: protocol,
             },
             {
-                name: 'AutoStake',
+                name: 'Auto-Stake',
                 value: autoStake.toString(),
             },
             {
-                name: 'ObserverAddress',
+                name: 'Observer-Address',
                 value: observerAddress,
             },
         ];
@@ -397,27 +397,27 @@ export class IOWriteable extends IOReadable {
         const { tags = [] } = options || {};
         const allTags = [
             ...tags,
-            { name: 'Action', value: 'UpdateGatewaySettings' },
+            { name: 'Action', value: 'Update-Gateway-Settings' },
             { name: 'Label', value: label },
             { name: 'Note', value: note },
             { name: 'FQDN', value: fqdn },
             { name: 'Port', value: port?.toString() },
             { name: 'Properties', value: properties },
             { name: 'Protocol', value: protocol },
-            { name: 'ObserverAddress', value: observerAddress },
+            { name: 'Observer-Address', value: observerAddress },
             {
-                name: 'AllowDelegatedStaking',
+                name: 'Allow-Delegated-Staking',
                 value: allowDelegatedStaking?.toString(),
             },
             {
-                name: 'DelegateRewardShareRatio',
+                name: 'Delegate-Reward-Share-Ratio',
                 value: delegateRewardShareRatio?.toString(),
             },
             {
-                name: 'MinDelegatedStake',
+                name: 'Min-Delegated-Stake',
                 value: minDelegatedStake?.valueOf().toString(),
             },
-            { name: 'AutoStake', value: autoStake?.toString() },
+            { name: 'Auto-Stake', value: autoStake?.toString() },
         ];
         const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.send({
@@ -431,7 +431,7 @@ export class IOWriteable extends IOReadable {
             signer: this.signer,
             tags: [
                 ...tags,
-                { name: 'Action', value: 'DelegateStake' },
+                { name: 'Action', value: 'Delegate-Stake' },
                 { name: 'Target', value: params.target },
                 { name: 'Quantity', value: params.stakeQty.valueOf().toString() },
             ],
@@ -443,7 +443,7 @@ export class IOWriteable extends IOReadable {
             signer: this.signer,
             tags: [
                 ...tags,
-                { name: 'Action', value: 'DecreaseDelegateStake' },
+                { name: 'Action', value: 'Decrease-Delegate-Stake' },
                 { name: 'Target', value: params.target },
                 { name: 'Quantity', value: params.decreaseQty.valueOf().toString() },
             ],
@@ -455,7 +455,7 @@ export class IOWriteable extends IOReadable {
             signer: this.signer,
             tags: [
                 ...tags,
-                { name: 'Action', value: 'IncreaseOperatorStake' },
+                { name: 'Action', value: 'Increase-Operator-Stake' },
                 { name: 'Quantity', value: params.increaseQty.valueOf().toString() },
             ],
         });
@@ -466,7 +466,7 @@ export class IOWriteable extends IOReadable {
             signer: this.signer,
             tags: [
                 ...tags,
-                { name: 'Action', value: 'DecreaseOperatorStake' },
+                { name: 'Action', value: 'Decrease-Operator-Stake' },
                 { name: 'Quantity', value: params.decreaseQty.valueOf().toString() },
             ],
         });
@@ -477,13 +477,13 @@ export class IOWriteable extends IOReadable {
             signer: this.signer,
             tags: [
                 ...tags,
-                { name: 'Action', value: 'SaveObservations' },
+                { name: 'Action', value: 'Save-Observations' },
                 {
-                    name: 'ReportTxId',
+                    name: 'Report-Tx-Id',
                     value: params.reportTxId,
                 },
                 {
-                    name: 'FailedGateways',
+                    name: 'Failed-Gateways',
                     value: params.failedGateways.join(','),
                 },
             ],
@@ -497,11 +497,11 @@ export class IOWriteable extends IOReadable {
         const { tags = [] } = options || {};
         const allTags = [
             ...tags,
-            { name: 'Action', value: 'BuyRecord' },
+            { name: 'Action', value: 'Buy-Record' },
             { name: 'Name', value: params.name },
             { name: 'Years', value: params.years?.toString() ?? '1' },
-            { name: 'ProcessId', value: params.processId },
-            { name: 'PurchaseType', value: params.type || 'lease' },
+            { name: 'Process-Id', value: params.processId },
+            { name: 'Purchase-Type', value: params.type || 'lease' },
         ];
         const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.send({
@@ -515,7 +515,7 @@ export class IOWriteable extends IOReadable {
             signer: this.signer,
             tags: [
                 ...tags,
-                { name: 'Action', value: 'ExtendLease' },
+                { name: 'Action', value: 'Extend-Lease' },
                 { name: 'Name', value: params.name },
                 { name: 'Years', value: params.years.toString() },
             ],
@@ -527,7 +527,7 @@ export class IOWriteable extends IOReadable {
             signer: this.signer,
             tags: [
                 ...tags,
-                { name: 'Action', value: 'IncreaseUndernameLimit' },
+                { name: 'Action', value: 'Increase-Undername-Limit' },
                 { name: 'Name', value: params.name },
                 { name: 'Quantity', value: params.increaseCount.toString() },
             ],

package/lib/esm/version.js

@@ -15,4 +15,4 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-export const version = '1.2.0-alpha.11';
+export const version = '1.2.0-alpha.13';

package/lib/types/common/ant-ao.d.ts

@@ -15,12 +15,13 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 import { ANTRecord } from '../contract-state.js';
-import { AoANTRead, AoANTWrite, ProcessConfiguration } from '../io.js';
+import { AoANTRead, AoANTState, AoANTWrite, ProcessConfiguration } from '../io.js';
 import { AoMessageResult, WalletAddress, WithSigner } from '../types.js';
 import { AOProcess } from './contracts/ao-process.js';
 export declare class AoANTReadable implements AoANTRead {
     protected process: AOProcess;
     constructor(config: Required<ProcessConfiguration>);
+    getState(): Promise<AoANTState>;
     getInfo(): Promise<{
         Name: string;
         Ticker: string;

package/lib/types/common/io.d.ts

@@ -66,18 +66,18 @@ export declare class IOReadable implements AoIORead {
     getObservations(epoch?: EpochInput): Promise<EpochObservations>;
     getDistributions(epoch?: EpochInput): Promise<EpochDistributionData>;
     getTokenCost(params: {
-        intent: 'BuyRecord';
+        intent: 'Buy-Record';
         purchaseType: 'permabuy' | 'lease';
         years: number;
         name: string;
     }): Promise<number>;
     getTokenCost(params: {
-        intent: 'ExtendLease';
+        intent: 'Extend-Lease';
         years: number;
         name: string;
     }): Promise<number>;
     getTokenCost(params: {
-        intent: 'IncreaseUndernameLimit';
+        intent: 'Increase-Undername-Limit';
         quantity: number;
         name: string;
     }): Promise<number>;

package/lib/types/io.d.ts

@@ -81,7 +81,7 @@ export interface AoIORead {
     getObservations(epoch?: EpochInput): Promise<EpochObservations>;
     getDistributions(epoch?: EpochInput): Promise<EpochDistributionData>;
     getTokenCost({ intent, purchaseType, years, name, quantity, }: {
-        intent: 'BuyRecord' | 'ExtendLease' | 'IncreaseUndernameLimit';
+        intent: 'Buy-Record' | 'Extend-Lease' | 'Increase-Undername-Limit';
         purchaseType?: 'permabuy' | 'lease';
         years?: number;
         name?: string;
@@ -244,3 +244,15 @@ export type AoGateway = {
     operatorStake: number;
     status: 'joined' | 'leaving';
 };
+export type AoANTState = {
+    Name: string;
+    Ticker: string;
+    Denomination: number;
+    Owner: WalletAddress;
+    Controllers: WalletAddress[];
+    Records: Record<string, ANTRecord>;
+    Balances: Record<WalletAddress, number>;
+    Logo: string;
+    TotalSupply: number;
+    Initialized: boolean;
+};

package/lib/types/version.d.ts

@@ -14,4 +14,4 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-export declare const version = "1.2.0-alpha.10";
+export declare const version = "1.2.0-alpha.12";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ar.io/sdk",
-  "version": "1.2.0-alpha.11",
+  "version": "1.2.0-alpha.13",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ar-io/ar-io-sdk.git"