SmartWalletWrapper | @gokiprotocol/client

Hierarchy

SmartWalletWrapper

Constructors

constructor

new SmartWalletWrapper(sdk: GokiSDK, args: InitSmartWalletWrapperArgs): SmartWalletWrapper

- Defined in src/wrappers/smartWallet/index.ts:33
Parameters
- sdk: GokiSDK
- args: InitSmartWalletWrapperArgs
Returns SmartWalletWrapper

Properties

Readonly bump

bump: number

Readonly key

key: PublicKey

Readonly program

program: AnchorProgram<SmartWalletIDL, { smartWallet: AnchorTypeDef<{ name: "SmartWallet"; type: { fields: [{ name: "base"; type: "publicKey" }, { name: "bump"; type: "u8" }, { name: "threshold"; type: "u64" }, { name: "minimumDelay"; type: "i64" }, { name: "gracePeriod"; type: "i64" }, { name: "ownerSetSeqno"; type: "u32" }, { name: "numTransactions"; type: "u64" }, { name: "owners"; type: { vec: "publicKey" } }, { name: "reserved"; type: { array: ["u64", 16] } }]; kind: "struct" } } & { name: "SmartWallet" } & never & never, AnchorDefined<SmartWalletIDL, { TXAccountMeta: AccountMeta; TXInstruction: SmartWalletInstruction }>>; subaccountInfo: AnchorTypeDef<never & never & { name: "SubaccountInfo"; type: { fields: [{ name: "smartWallet"; type: "publicKey" }, { name: "subaccountType"; type: { defined: "SubaccountType" } }, { name: "index"; type: "u64" }]; kind: "struct" } } & { name: "SubaccountInfo" }, AnchorDefined<SmartWalletIDL, { TXAccountMeta: AccountMeta; TXInstruction: SmartWalletInstruction }>>; transaction: AnchorTypeDef<never & { name: "Transaction"; type: { fields: [{ name: "smartWallet"; type: "publicKey" }, { name: "index"; type: "u64" }, { name: "bump"; type: "u8" }, { name: "proposer"; type: "publicKey" }, { name: "instructions"; type: { vec: { defined: "TXInstruction" } } }, { name: "signers"; type: { vec: "bool" } }, { name: "ownerSetSeqno"; type: "u32" }]; kind: "struct" } } & { name: "Transaction" } & never, AnchorDefined<SmartWalletIDL, { TXAccountMeta: AccountMeta; TXInstruction: SmartWalletInstruction }>> }, AnchorDefined<SmartWalletIDL, { TXAccountMeta: AccountMeta; TXInstruction: SmartWalletInstruction }>, MakeInstructions<[{ accounts: [{ isMut: false; isSigner: true; name: "base" }, { isMut: true; isSigner: false; name: "smartWallet"; pda: { seeds: [{ kind: "const"; type: "string"; value: "GokiSmartWallet" }, { kind: "account"; path: "base"; type: "publicKey" }] } }, { isMut: true; isSigner: true; name: "payer" }, { isMut: false; isSigner: false; name: "systemProgram" }]; args: [{ name: "bump"; type: "u8" }, { name: "maxOwners"; type: "u8" }, { name: "owners"; type: { vec: "publicKey" } }, { name: "threshold"; type: "u64" }, { name: "minimumDelay"; type: "i64" }]; name: "createSmartWallet" }, { accounts: [{ isMut: true; isSigner: true; name: "smartWallet" }]; args: [{ name: "owners"; type: { vec: "publicKey" } }]; name: "setOwners" }, { accounts: [{ isMut: true; isSigner: true; name: "smartWallet" }]; args: [{ name: "threshold"; type: "u64" }]; name: "changeThreshold" }], AnchorDefined<SmartWalletIDL, { TXAccountMeta: AccountMeta; TXInstruction: SmartWalletInstruction }>>, MakeInstructions<unknown, AnchorDefined<SmartWalletIDL, { TXAccountMeta: AccountMeta; TXInstruction: SmartWalletInstruction }>>>

Readonly sdk

sdk: GokiSDK

Accessors

data

get data(): undefined | AnchorTypeDef<{ name: "SmartWallet"; type: { fields: [{ name: "base"; type: "publicKey" }, { name: "bump"; type: "u8" }, { name: "threshold"; type: "u64" }, { name: "minimumDelay"; type: "i64" }, { name: "gracePeriod"; type: "i64" }, { name: "ownerSetSeqno"; type: "u32" }, { name: "numTransactions"; type: "u64" }, { name: "owners"; type: { vec: "publicKey" } }, { name: "reserved"; type: { array: ["u64", 16] } }]; kind: "struct" } } & { name: "SmartWallet" } & never & never, AnchorDefined<SmartWalletIDL, { TXAccountMeta: AccountMeta; TXInstruction: SmartWalletInstruction }>>

- Defined in src/wrappers/smartWallet/index.ts:44
Returns undefined | AnchorTypeDef<{ name: "SmartWallet"; type: { fields: [{ name: "base"; type: "publicKey" }, { name: "bump"; type: "u8" }, { name: "threshold"; type: "u64" }, { name: "minimumDelay"; type: "i64" }, { name: "gracePeriod"; type: "i64" }, { name: "ownerSetSeqno"; type: "u32" }, { name: "numTransactions"; type: "u64" }, { name: "owners"; type: { vec: "publicKey" } }, { name: "reserved"; type: { array: ["u64", 16] } }]; kind: "struct" } } & { name: "SmartWallet" } & never & never, AnchorDefined<SmartWalletIDL, { TXAccountMeta: AccountMeta; TXInstruction: SmartWalletInstruction }>>

provider

get provider(): AugmentedProvider

- Defined in src/wrappers/smartWallet/index.ts:40
Returns AugmentedProvider

Methods

approveTransaction

approveTransaction(transactionKey: PublicKey, owner?: PublicKey): TransactionEnvelope

- Defined in src/wrappers/smartWallet/index.ts:140
Approves a transaction.

Parameters
- transactionKey: PublicKey
- owner: PublicKey = ...
Returns TransactionEnvelope

changeThreshold

changeThreshold(threshold: number): TransactionEnvelope

- Defined in src/wrappers/smartWallet/index.ts:360
changeThreshold

Parameters
- threshold: number
Returns TransactionEnvelope

executeTransaction

executeTransaction(__namedParameters: { owner?: PublicKey; transactionKey: PublicKey }): Promise<TransactionEnvelope>

- Defined in src/wrappers/smartWallet/index.ts:158
Executes a transaction as the Smart Wallet.

Parameters
- __namedParameters: { owner?: PublicKey; transactionKey: PublicKey }
  - Optional owner?: PublicKey
  - transactionKey: PublicKey
Returns Promise<TransactionEnvelope>

executeTransactionDerived

executeTransactionDerived(__namedParameters: { owner?: PublicKey; transactionKey: PublicKey; walletIndex: number }): Promise<TransactionEnvelope>

- Defined in src/wrappers/smartWallet/index.ts:231
Executes a transaction using a wallet-derived address.

Parameters
- __namedParameters: { owner?: PublicKey; transactionKey: PublicKey; walletIndex: number }
  - Optional owner?: PublicKey
  - transactionKey: PublicKey
  - walletIndex: number
Returns Promise<TransactionEnvelope>

fetchTransaction

fetchTransaction(key: PublicKey): Promise<AnchorTypeDef<never & { name: "Transaction"; type: { fields: [{ name: "smartWallet"; type: "publicKey" }, { name: "index"; type: "u64" }, { name: "bump"; type: "u8" }, { name: "proposer"; type: "publicKey" }, { name: "instructions"; type: { vec: { defined: "TXInstruction" } } }, { name: "signers"; type: { vec: "bool" } }, { name: "ownerSetSeqno"; type: "u32" }]; kind: "struct" } } & { name: "Transaction" } & never, AnchorDefined<SmartWalletIDL, { TXAccountMeta: AccountMeta; TXInstruction: SmartWalletInstruction }>>>

- Defined in src/wrappers/smartWallet/index.ts:133
fetchTransaction

Parameters
- key: PublicKey
Returns Promise<AnchorTypeDef<never & { name: "Transaction"; type: { fields: [{ name: "smartWallet"; type: "publicKey" }, { name: "index"; type: "u64" }, { name: "bump"; type: "u8" }, { name: "proposer"; type: "publicKey" }, { name: "instructions"; type: { vec: { defined: "TXInstruction" } } }, { name: "signers"; type: { vec: "bool" } }, { name: "ownerSetSeqno"; type: "u32" }]; kind: "struct" } } & { name: "Transaction" } & never, AnchorDefined<SmartWalletIDL, { TXAccountMeta: AccountMeta; TXInstruction: SmartWalletInstruction }>>>

fetchTransactionByIndex

fetchTransactionByIndex(index: number): Promise<null | AnchorTypeDef<never & { name: "Transaction"; type: { fields: [{ name: "smartWallet"; type: "publicKey" }, { name: "index"; type: "u64" }, { name: "bump"; type: "u8" }, { name: "proposer"; type: "publicKey" }, { name: "instructions"; type: { vec: { defined: "TXInstruction" } } }, { name: "signers"; type: { vec: "bool" } }, { name: "ownerSetSeqno"; type: "u32" }]; kind: "struct" } } & { name: "Transaction" } & never, AnchorDefined<SmartWalletIDL, { TXAccountMeta: AccountMeta; TXInstruction: SmartWalletInstruction }>>>

- Defined in src/wrappers/smartWallet/index.ts:123
Fetches a transaction by its index.

Parameters
- index: number
Returns Promise<null | AnchorTypeDef<never & { name: "Transaction"; type: { fields: [{ name: "smartWallet"; type: "publicKey" }, { name: "index"; type: "u64" }, { name: "bump"; type: "u8" }, { name: "proposer"; type: "publicKey" }, { name: "instructions"; type: { vec: { defined: "TXInstruction" } } }, { name: "signers"; type: { vec: "bool" } }, { name: "ownerSetSeqno"; type: "u32" }]; kind: "struct" } } & { name: "Transaction" } & never, AnchorDefined<SmartWalletIDL, { TXAccountMeta: AccountMeta; TXInstruction: SmartWalletInstruction }>>>

findOwnerInvokerAddress

findOwnerInvokerAddress(index: number): Promise<[PublicKey, number]>

- Defined in src/wrappers/smartWallet/index.ts:185
Finds the owner invoker address and bump of a given index.

Parameters
- index: number
Returns Promise<[PublicKey, number]>

findWalletDerivedAddress

findWalletDerivedAddress(index: number): Promise<[PublicKey, number]>

- Defined in src/wrappers/smartWallet/index.ts:176
Finds the derived wallet address and bump of a given index.

Parameters
- index: number
Returns Promise<[PublicKey, number]>

newTransaction

newTransaction(__namedParameters: NewTransactionArgs): Promise<PendingSmartWalletTransaction>

- Defined in src/wrappers/smartWallet/index.ts:62
Proposes a new transaction.

Parameters
- __namedParameters: NewTransactionArgs
Returns Promise<PendingSmartWalletTransaction>

newTransactionFromEnvelope

newTransactionFromEnvelope(__namedParameters: Omit<NewTransactionArgs, "instructions"> & { tx: TransactionEnvelope }): Promise<PendingSmartWalletTransaction>

- Defined in src/wrappers/smartWallet/index.ts:108
Creates a new transaction from an envelope.

Parameters
- __namedParameters: Omit<NewTransactionArgs, "instructions"> & { tx: TransactionEnvelope }
Returns Promise<PendingSmartWalletTransaction>

ownerInvokeInstruction

ownerInvokeInstruction(__namedParameters: { index: number; instruction: TransactionInstruction; owner?: PublicKey }): Promise<TransactionEnvelope>

- Defined in src/wrappers/smartWallet/index.ts:257
Executes a transaction using an owner invoker address.

Parameters
- __namedParameters: { index: number; instruction: TransactionInstruction; owner?: PublicKey }
  - index: number
  - instruction: TransactionInstruction
  - Optional owner?: PublicKey
Returns Promise<TransactionEnvelope>

ownerInvokeInstructionV2

ownerInvokeInstructionV2(__namedParameters: { index: number; instruction: TransactionInstruction; owner?: PublicKey }): Promise<TransactionEnvelope>

- Defined in src/wrappers/smartWallet/index.ts:302
Executes a transaction using an owner invoker address.

Parameters
- __namedParameters: { index: number; instruction: TransactionInstruction; owner?: PublicKey }
  - index: number
  - instruction: TransactionInstruction
  - Optional owner?: PublicKey
Returns Promise<TransactionEnvelope>

reloadData

reloadData(): Promise<AnchorTypeDef<{ name: "SmartWallet"; type: { fields: [{ name: "base"; type: "publicKey" }, { name: "bump"; type: "u8" }, { name: "threshold"; type: "u64" }, { name: "minimumDelay"; type: "i64" }, { name: "gracePeriod"; type: "i64" }, { name: "ownerSetSeqno"; type: "u32" }, { name: "numTransactions"; type: "u64" }, { name: "owners"; type: { vec: "publicKey" } }, { name: "reserved"; type: { array: ["u64", 16] } }]; kind: "struct" } } & { name: "SmartWallet" } & never & never, AnchorDefined<SmartWalletIDL, { TXAccountMeta: AccountMeta; TXInstruction: SmartWalletInstruction }>>>

- Defined in src/wrappers/smartWallet/index.ts:51
reloadData

Returns Promise<AnchorTypeDef<{ name: "SmartWallet"; type: { fields: [{ name: "base"; type: "publicKey" }, { name: "bump"; type: "u8" }, { name: "threshold"; type: "u64" }, { name: "minimumDelay"; type: "i64" }, { name: "gracePeriod"; type: "i64" }, { name: "ownerSetSeqno"; type: "u32" }, { name: "numTransactions"; type: "u64" }, { name: "owners"; type: { vec: "publicKey" } }, { name: "reserved"; type: { array: ["u64", 16] } }]; kind: "struct" } } & { name: "SmartWallet" } & never & never, AnchorDefined<SmartWalletIDL, { TXAccountMeta: AccountMeta; TXInstruction: SmartWalletInstruction }>>>

setOwners

setOwners(owners: PublicKey[]): TransactionEnvelope

- Defined in src/wrappers/smartWallet/index.ts:348
setOwners

Parameters
- owners: PublicKey[]
Returns TransactionEnvelope

Static load

load(sdk: GokiSDK, key: PublicKey): Promise<SmartWalletWrapper>

- Defined in src/wrappers/smartWallet/index.ts:372
Loads a SmartWallet

Parameters
- sdk: GokiSDK
- key: PublicKey
Returns Promise<SmartWalletWrapper>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

sdk: GokiSDK

args: InitSmartWalletWrapperArgs

Returns SmartWalletWrapper

Properties

Readonly bump

Readonly key

Readonly program

Readonly sdk

Accessors

data

provider

Returns AugmentedProvider

Methods

approveTransaction

Parameters

transactionKey: PublicKey

owner: PublicKey = ...

Returns TransactionEnvelope

changeThreshold

Parameters

threshold: number

Returns TransactionEnvelope

executeTransaction

Parameters

__namedParameters: { owner?: PublicKey; transactionKey: PublicKey }

Optional owner?: PublicKey

transactionKey: PublicKey

Returns Promise<TransactionEnvelope>

executeTransactionDerived

Parameters

__namedParameters: { owner?: PublicKey; transactionKey: PublicKey; walletIndex: number }

Optional owner?: PublicKey

transactionKey: PublicKey

walletIndex: number

Returns Promise<TransactionEnvelope>

fetchTransaction

Parameters

key: PublicKey

fetchTransactionByIndex

Parameters

index: number

findOwnerInvokerAddress

Parameters

index: number

Returns Promise<[PublicKey, number]>

findWalletDerivedAddress

Parameters

index: number

Returns Promise<[PublicKey, number]>

newTransaction

Parameters

__namedParameters: NewTransactionArgs

Returns Promise<PendingSmartWalletTransaction>

newTransactionFromEnvelope

Parameters

__namedParameters: Omit<NewTransactionArgs, "instructions"> & { tx: TransactionEnvelope }

Returns Promise<PendingSmartWalletTransaction>

ownerInvokeInstruction

Parameters

__namedParameters: { index: number; instruction: TransactionInstruction; owner?: PublicKey }

index: number

instruction: TransactionInstruction

Optional owner?: PublicKey

Returns Promise<TransactionEnvelope>

ownerInvokeInstructionV2

Parameters

__namedParameters: { index: number; instruction: TransactionInstruction; owner?: PublicKey }

index: number

instruction: TransactionInstruction

Optional owner?: PublicKey

Returns Promise<TransactionEnvelope>