@loyal-labs/loyal-smart-accounts-core 0.1.1

package/dist/src/spec/operation-registry.js

@@ -0,0 +1,390 @@
+import { EXTRA_FEATURE_ACTIONS, FEATURE_INSTRUCTION_COVERAGE, } from "./features.js";
+const featureInstructionCoverage = FEATURE_INSTRUCTION_COVERAGE;
+const extraFeatureActions = EXTRA_FEATURE_ACTIONS;
+export const OPERATION_REGISTRY = {
+    initializeProgramConfig: {
+        feature: "programConfig",
+        instruction: "initializeProgramConfig",
+        exportName: "initialize",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer", "initializer"],
+    },
+    setProgramConfigAuthority: {
+        feature: "programConfig",
+        instruction: "setProgramConfigAuthority",
+        exportName: "setAuthority",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer", "authority"],
+    },
+    setProgramConfigSmartAccountCreationFee: {
+        feature: "programConfig",
+        instruction: "setProgramConfigSmartAccountCreationFee",
+        exportName: "setSmartAccountCreationFee",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer", "authority"],
+    },
+    setProgramConfigTreasury: {
+        feature: "programConfig",
+        instruction: "setProgramConfigTreasury",
+        exportName: "setTreasury",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer", "authority"],
+    },
+    createSmartAccount: {
+        feature: "smartAccounts",
+        instruction: "createSmartAccount",
+        exportName: "create",
+        phase: "offline",
+        payerRole: "creator",
+        signerRoles: ["creator"],
+    },
+    addSignerAsAuthority: {
+        feature: "smartAccounts",
+        instruction: "addSignerAsAuthority",
+        exportName: "addSigner",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer", "rentPayer"],
+    },
+    removeSignerAsAuthority: {
+        feature: "smartAccounts",
+        instruction: "removeSignerAsAuthority",
+        exportName: "removeSigner",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer"],
+    },
+    setTimeLockAsAuthority: {
+        feature: "smartAccounts",
+        instruction: "setTimeLockAsAuthority",
+        exportName: "setTimeLock",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer"],
+    },
+    changeThresholdAsAuthority: {
+        feature: "smartAccounts",
+        instruction: "changeThresholdAsAuthority",
+        exportName: "changeThreshold",
+        phase: "offline",
+        payerRole: "settingsAuthority",
+        signerRoles: ["settingsAuthority", "rentPayer"],
+    },
+    setNewSettingsAuthorityAsAuthority: {
+        feature: "smartAccounts",
+        instruction: "setNewSettingsAuthorityAsAuthority",
+        exportName: "setNewSettingsAuthority",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer"],
+    },
+    setArchivalAuthorityAsAuthority: {
+        feature: "smartAccounts",
+        instruction: "setArchivalAuthorityAsAuthority",
+        exportName: "setArchivalAuthority",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer"],
+    },
+    createSettingsTransaction: {
+        feature: "smartAccounts",
+        instruction: "createSettingsTransaction",
+        exportName: "createSettingsTransaction",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer"],
+    },
+    closeSettingsTransaction: {
+        feature: "smartAccounts",
+        instruction: "closeSettingsTransaction",
+        exportName: "closeSettingsTransaction",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer"],
+    },
+    createProposal: {
+        feature: "proposals",
+        instruction: "createProposal",
+        exportName: "create",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer", "creator", "rentPayer"],
+        signerFallbacks: {
+            rentPayer: "creator",
+        },
+    },
+    activateProposal: {
+        feature: "proposals",
+        instruction: "activateProposal",
+        exportName: "activate",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer", "signer"],
+    },
+    approveProposal: {
+        feature: "proposals",
+        instruction: "approveProposal",
+        exportName: "approve",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer", "signer"],
+    },
+    rejectProposal: {
+        feature: "proposals",
+        instruction: "rejectProposal",
+        exportName: "reject",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer", "signer"],
+    },
+    cancelProposal: {
+        feature: "proposals",
+        instruction: "cancelProposal",
+        exportName: "cancel",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer", "signer"],
+    },
+    createTransaction: {
+        feature: "transactions",
+        instruction: "createTransaction",
+        exportName: "create",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer"],
+    },
+    createTransactionBuffer: {
+        feature: "transactions",
+        instruction: "createTransactionBuffer",
+        exportName: "createBuffer",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer", "creator", "rentPayer"],
+        signerFallbacks: {
+            rentPayer: "creator",
+        },
+    },
+    closeTransactionBuffer: {
+        feature: "transactions",
+        instruction: "closeTransactionBuffer",
+        exportName: "closeBuffer",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer", "creator"],
+    },
+    extendTransactionBuffer: {
+        feature: "transactions",
+        instruction: "extendTransactionBuffer",
+        exportName: "extendBuffer",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer", "creator"],
+    },
+    createTransactionFromBuffer: {
+        feature: "transactions",
+        instruction: "createTransactionFromBuffer",
+        exportName: "createFromBuffer",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer", "creator", "rentPayer"],
+        signerFallbacks: {
+            rentPayer: "creator",
+        },
+    },
+    closeTransaction: {
+        feature: "transactions",
+        instruction: "closeTransaction",
+        exportName: "close",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer"],
+    },
+    logEvent: {
+        feature: "transactions",
+        instruction: "logEvent",
+        exportName: "logEvent",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer", "logAuthority"],
+    },
+    createBatch: {
+        feature: "batches",
+        instruction: "createBatch",
+        exportName: "create",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer", "creator", "rentPayer"],
+        signerFallbacks: {
+            rentPayer: "creator",
+        },
+    },
+    addTransactionToBatch: {
+        feature: "batches",
+        instruction: "addTransactionToBatch",
+        exportName: "addTransaction",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer", "signer", "rentPayer"],
+        signerFallbacks: {
+            rentPayer: "signer",
+        },
+        exposeInstruction: false,
+        requiresLookupTables: true,
+    },
+    closeBatchTransaction: {
+        feature: "batches",
+        instruction: "closeBatchTransaction",
+        exportName: "closeTransaction",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer"],
+    },
+    closeBatch: {
+        feature: "batches",
+        instruction: "closeBatch",
+        exportName: "close",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer"],
+    },
+    createPolicyTransaction: {
+        feature: "policies",
+        instruction: "createPolicyTransaction",
+        exportName: "createTransaction",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer"],
+    },
+    closeEmptyPolicyTransaction: {
+        feature: "policies",
+        instruction: "closeEmptyPolicyTransaction",
+        exportName: "closeEmptyTransaction",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer"],
+    },
+    addSpendingLimitAsAuthority: {
+        feature: "spendingLimits",
+        instruction: "addSpendingLimitAsAuthority",
+        exportName: "add",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer", "settingsAuthority", "rentPayer"],
+    },
+    removeSpendingLimitAsAuthority: {
+        feature: "spendingLimits",
+        instruction: "removeSpendingLimitAsAuthority",
+        exportName: "remove",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer"],
+    },
+    useSpendingLimit: {
+        feature: "spendingLimits",
+        instruction: "useSpendingLimit",
+        exportName: "use",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer", "signer"],
+    },
+    executeSettingsTransaction: {
+        feature: "execution",
+        instruction: "executeSettingsTransaction",
+        exportName: "executeSettingsTransaction",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer", "signer", "rentPayer"],
+        requiresConfirmation: true,
+    },
+    executeTransaction: {
+        feature: "execution",
+        instruction: "executeTransaction",
+        exportName: "executeTransaction",
+        phase: "online",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer"],
+        requiresConnection: true,
+        requiresLookupTables: true,
+        requiresConfirmation: true,
+    },
+    executeBatchTransaction: {
+        feature: "execution",
+        instruction: "executeBatchTransaction",
+        exportName: "executeBatchTransaction",
+        phase: "online",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer", "signer"],
+        requiresConnection: true,
+        requiresLookupTables: true,
+        requiresConfirmation: true,
+    },
+    executeTransactionSync: {
+        feature: "execution",
+        instruction: "executeTransactionSync",
+        exportName: "executeTransactionSync",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer", "signers"],
+    },
+    executeTransactionSyncV2: {
+        feature: "execution",
+        instruction: "executeTransactionSyncV2",
+        exportName: "executeTransactionSyncV2",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer"],
+    },
+    executeSettingsTransactionSync: {
+        feature: "execution",
+        instruction: "executeSettingsTransactionSync",
+        exportName: "executeSettingsTransactionSync",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer", "signers"],
+    },
+    executePolicyTransaction: {
+        feature: "execution",
+        instruction: "executePolicyTransaction",
+        exportName: "executePolicyTransaction",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer"],
+    },
+    executePolicyPayloadSync: {
+        feature: "execution",
+        instruction: "executePolicyPayloadSync",
+        exportName: "executePolicyPayloadSync",
+        phase: "offline",
+        payerRole: "feePayer",
+        signerRoles: ["feePayer"],
+    },
+};
+export const OPERATION_NAMES = Object.keys(OPERATION_REGISTRY);
+export const FEATURE_EXPORTS_FROM_REGISTRY = Object.fromEntries(Object.entries(OPERATION_REGISTRY).map(([operation, metadata]) => [
+    operation,
+    metadata.exportName,
+]));
+export function getOperationsForFeature(feature) {
+    return OPERATION_NAMES.filter((operation) => OPERATION_REGISTRY[operation].feature === feature);
+}
+export function findOperationCoverageIssues() {
+    const missingMappings = [
+        ...Object.values(featureInstructionCoverage).flat(),
+        ...Object.values(extraFeatureActions).flat(),
+    ].filter((instruction) => !OPERATION_NAMES.includes(instruction));
+    const duplicateExports = Object.values(OPERATION_REGISTRY).reduce((accumulator, metadata) => {
+        const key = `${metadata.feature}:${metadata.exportName}`;
+        accumulator[key] = (accumulator[key] ?? 0) + 1;
+        return accumulator;
+    }, {});
+    return {
+        missingMappings,
+        duplicateExports: Object.entries(duplicateExports)
+            .filter(([, count]) => count > 1)
+            .map(([key]) => key),
+    };
+}

package/dist/src/spec/pda-registry.d.ts

@@ -0,0 +1,32 @@
+export declare const PDA_REGISTRY: {
+    readonly programConfig: {
+        readonly seeds: readonly ["smart_account", "program_config"];
+    };
+    readonly settings: {
+        readonly seeds: readonly ["smart_account", "settings", "accountIndex:u128"];
+    };
+    readonly smartAccount: {
+        readonly seeds: readonly ["smart_account", "settingsPda:pubkey", "smart_account", "accountIndex:u8"];
+    };
+    readonly transaction: {
+        readonly seeds: readonly ["smart_account", "settingsPda:pubkey", "transaction", "transactionIndex:u64"];
+    };
+    readonly proposal: {
+        readonly seeds: readonly ["smart_account", "settingsPda:pubkey", "transaction", "transactionIndex:u64", "proposal"];
+    };
+    readonly batchTransaction: {
+        readonly seeds: readonly ["smart_account", "settingsPda:pubkey", "transaction", "batchIndex:u64", "batch_transaction", "transactionIndex:u32"];
+    };
+    readonly ephemeralSigner: {
+        readonly seeds: readonly ["smart_account", "transactionPda:pubkey", "ephemeral_signer", "ephemeralSignerIndex:u8"];
+    };
+    readonly spendingLimit: {
+        readonly seeds: readonly ["smart_account", "settingsPda:pubkey", "spending_limit", "seed:pubkey"];
+    };
+    readonly transactionBuffer: {
+        readonly seeds: readonly ["smart_account", "consensusPda:pubkey", "transaction_buffer", "creator:pubkey", "bufferIndex:u8"];
+    };
+    readonly policy: {
+        readonly seeds: readonly ["smart_account", "policy", "settingsPda:pubkey", "policySeed:u64"];
+    };
+};

package/dist/src/spec/pda-registry.js

@@ -0,0 +1,71 @@
+export const PDA_REGISTRY = {
+    programConfig: {
+        seeds: ["smart_account", "program_config"],
+    },
+    settings: {
+        seeds: ["smart_account", "settings", "accountIndex:u128"],
+    },
+    smartAccount: {
+        seeds: [
+            "smart_account",
+            "settingsPda:pubkey",
+            "smart_account",
+            "accountIndex:u8",
+        ],
+    },
+    transaction: {
+        seeds: [
+            "smart_account",
+            "settingsPda:pubkey",
+            "transaction",
+            "transactionIndex:u64",
+        ],
+    },
+    proposal: {
+        seeds: [
+            "smart_account",
+            "settingsPda:pubkey",
+            "transaction",
+            "transactionIndex:u64",
+            "proposal",
+        ],
+    },
+    batchTransaction: {
+        seeds: [
+            "smart_account",
+            "settingsPda:pubkey",
+            "transaction",
+            "batchIndex:u64",
+            "batch_transaction",
+            "transactionIndex:u32",
+        ],
+    },
+    ephemeralSigner: {
+        seeds: [
+            "smart_account",
+            "transactionPda:pubkey",
+            "ephemeral_signer",
+            "ephemeralSignerIndex:u8",
+        ],
+    },
+    spendingLimit: {
+        seeds: [
+            "smart_account",
+            "settingsPda:pubkey",
+            "spending_limit",
+            "seed:pubkey",
+        ],
+    },
+    transactionBuffer: {
+        seeds: [
+            "smart_account",
+            "consensusPda:pubkey",
+            "transaction_buffer",
+            "creator:pubkey",
+            "bufferIndex:u8",
+        ],
+    },
+    policy: {
+        seeds: ["smart_account", "policy", "settingsPda:pubkey", "policySeed:u64"],
+    },
+};

package/dist/src/transport.d.ts

@@ -0,0 +1 @@
+export * from "./core/transport/index.js";

package/dist/src/transport.js

@@ -0,0 +1 @@
+export * from "./core/transport/index.js";

package/dist/src/types.d.ts

@@ -0,0 +1,69 @@
+import * as beet from "@metaplex-foundation/beet";
+import { PublicKey } from "@solana/web3.js";
+import type { Permissions as IPermissions } from "./generated";
+export { isProposalStatusActive, isProposalStatusApproved, isProposalStatusRejected, isProposalStatusCancelled, isProposalStatusExecuted, isSettingsActionAddSigner, isSettingsActionRemoveSigner, isSettingsActionChangeThreshold, isSettingsActionAddSpendingLimit, isSettingsActionRemoveSpendingLimit, isSettingsActionSetTimeLock, } from "./generated";
+export type { Period, SettingsAction, SettingsActionRecord, SmartAccountSigner, } from "./generated";
+export declare const Permission: {
+    readonly Initiate: 1;
+    readonly Vote: 2;
+    readonly Execute: 4;
+};
+export type Permission = typeof Permission[keyof typeof Permission];
+export declare class Permissions implements IPermissions {
+    readonly mask: number;
+    private constructor();
+    static fromPermissions(permissions: Permission[]): Permissions;
+    static all(): Permissions;
+    static has(permissions: IPermissions, permission: Permission): boolean;
+}
+/**
+ * De/Serializes a small array with configurable length prefix and a specific number of elements of type {@link T}
+ * which do not all have the same size.
+ *
+ * @template T type of elements held in the array
+ *
+ * @param lengthBeet the De/Serializer for the array length prefix
+ * @param elements the De/Serializers for the element types
+ * @param elementsByteSize size of all elements in the array combined
+ *
+ * The implementation is minor modification of `fixedSizeArray` where the length is encoded as `lengthBeet.byteSize` bytes:
+ * https://github.dev/metaplex-foundation/beet/blob/e053b7b5b0c46ce7f6906ecd38be9fd85d6e5254/beet/src/beets/collections.ts#L84
+ */
+export declare function fixedSizeSmallArray<T, V = Partial<T>>(lengthBeet: beet.FixedSizeBeet<number>, elements: beet.FixedSizeBeet<T, V>[], elementsByteSize: number): beet.FixedSizeBeet<T[], V[]>;
+/**
+ * Wraps a small array De/Serializer with configurable length prefix and elements of type {@link T}
+ * which do not all have the same size.
+ *
+ * @template T type of elements held in the array
+ *
+ * @param lengthBeet the De/Serializer for the array length prefix
+ * @param element the De/Serializer for the element types
+ *
+ * The implementation is minor modification of `array` where the length is encoded as `lengthBeet.byteSize` bytes:
+ * https://github.dev/metaplex-foundation/beet/blob/e053b7b5b0c46ce7f6906ecd38be9fd85d6e5254/beet/src/beets/collections.ts#L137
+ */
+export declare function smallArray<T, V = Partial<T>>(lengthBeet: beet.FixedSizeBeet<number>, element: beet.Beet<T, V>): beet.FixableBeet<T[], V[]>;
+export type CompiledMsInstruction = {
+    programIdIndex: number;
+    accountIndexes: number[];
+    data: number[];
+};
+export declare const compiledMsInstructionBeet: beet.FixableBeetArgsStruct<CompiledMsInstruction>;
+export type MessageAddressTableLookup = {
+    /** Address lookup table account key */
+    accountKey: PublicKey;
+    /** List of indexes used to load writable account addresses */
+    writableIndexes: number[];
+    /** List of indexes used to load readonly account addresses */
+    readonlyIndexes: number[];
+};
+export declare const messageAddressTableLookupBeet: beet.FixableBeetArgsStruct<MessageAddressTableLookup>;
+export type TransactionMessage = {
+    numSigners: number;
+    numWritableSigners: number;
+    numWritableNonSigners: number;
+    accountKeys: PublicKey[];
+    instructions: CompiledMsInstruction[];
+    addressTableLookups: MessageAddressTableLookup[];
+};
+export declare const transactionMessageBeet: beet.FixableBeetArgsStruct<TransactionMessage>;