Skip to content

loginCall(options): object

Defined in: packages/synapse-core/src/session-key/login.ts:116

Create a call to the login function.

ParameterTypeDescription
options{ address: `0x${string}`; chain: Chain; contractAddress?: `0x${string}`; expiresAt?: bigint; origin?: string; permissions?: SessionKeyPermissions[]; }loginCall.OptionsType
options.address`0x${string}`Session key address.
options.chainChainThe chain to use to make the call.
options.contractAddress?`0x${string}`Session key registry contract address. If not provided, defaults to the chain contract address.
options.expiresAt?bigintThe expiry time as Unix timestamp (seconds). Defaults to now + 1 hour.
options.origin?stringThe origin of the session key authorization. Defaults to ‘synapse’.
options.permissions?SessionKeyPermissions[]The permissions to authorize for the session key. Defaults to all permissions.

object

The call object loginCall.OutputType

abi: readonly [{ inputs: readonly [{ internalType: "address"; name: "user"; type: "address"; }, { internalType: "address"; name: "signer"; type: "address"; }, { internalType: "bytes32"; name: "permission"; type: "bytes32"; }]; name: "authorizationExpiry"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "signer"; type: "address"; }, { internalType: "uint256"; name: "expiry"; type: "uint256"; }, { internalType: "bytes32[]"; name: "permissions"; type: "bytes32[]"; }, { internalType: "string"; name: "origin"; type: "string"; }]; name: "login"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address payable"; name: "signer"; type: "address"; }, { internalType: "uint256"; name: "expiry"; type: "uint256"; }, { internalType: "bytes32[]"; name: "permissions"; type: "bytes32[]"; }, { internalType: "string"; name: "origin"; type: "string"; }]; name: "loginAndFund"; outputs: readonly []; stateMutability: "payable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "signer"; type: "address"; }, { internalType: "bytes32[]"; name: "permissions"; type: "bytes32[]"; }, { internalType: "string"; name: "origin"; type: "string"; }]; name: "revoke"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "identity"; type: "address"; }, { indexed: false; internalType: "address"; name: "signer"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "expiry"; type: "uint256"; }, { indexed: false; internalType: "bytes32[]"; name: "permissions"; type: "bytes32[]"; }, { indexed: false; internalType: "string"; name: "origin"; type: "string"; }]; name: "AuthorizationsUpdated"; type: "event"; }] = chain.contracts.sessionKeyRegistry.abi

address: `0x${string}`

args: [`0x${string}`, bigint, `0x${string}`[], string]

functionName: "login" = 'login'

Errors loginCall.ErrorType