# @integraledger/lcp/starknet > The exports of @integraledger/lcp/starknet. Source: https://lcp.integraledger.com/reference/api/starknet ## Interfaces ### Field #### Properties | Property | Type | | -------- | -------- | | `name` | `string` | | `type` | `string` | *** ### OutsideExecutionTypedData SNIP-12 revision 1, SNIP-9 v2, as x402's Starknet scheme prints it. #### Properties | Property | Type | | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `domain` | `object` | | `domain.chainId` | `` `0x${string}` `` | | `domain.name` | `"Account.execute_from_outside"` | | `domain.revision` | `1` | | `domain.version` | `2` | | `message` | `object` | | `message.Caller` | `` `0x${string}` `` | | `message.Calls` | \[\{ `Calldata`: \[`` `0x${string}` ``, `` `0x${string}` ``, `` `0x${string}` ``]; `Selector`: `"0x83afd3f4caedc6eebf44246fe54e38c95e3179a5ec9ea81740eca5b482d12e"`; `To`: `` `0x${string}` ``; }] | | `message.Execute After` | `"1"` | | `message.Execute Before` | `string` | | `message.Nonce` | `` `0x${string}` `` | | `primaryType` | `"OutsideExecution"` | | `types` | `object` | | `types.Call` | [`Field`](#field)\[] | | `types.OutsideExecution` | [`Field`](#field)\[] | | `types.StarknetDomain` | [`Field`](#field)\[] | *** ### StarknetInvocation #### Properties | Property | Type | | ----------- | ------------------------------------------------------- | | `calldata` | readonly `` `0x${string}` ``\[] | | `calls` | readonly [`StarknetInvocation`](#starknetinvocation)\[] | | `contract` | `` `0x${string}` `` | | `reverted` | `boolean` | | `selector` | `` `0x${string}` `` | *** ### StarknetReader Bounded, read-only calls against one network's JSON-RPC node. Every failure rejects with `ReaderError`. #### Properties | Property | Modifier | Type | | ---------- | ---------- | ------------------------------------- | | `network` | `readonly` | [`StarknetNetwork`](#starknetnetwork) | #### Methods ##### receipt() > **receipt**(`tx`): `Promise`\<[`StarknetReceipt`](#starknetreceipt) | `null`> `starknet_getTransactionReceipt`; null: unknown hash. ###### Parameters | Parameter | Type | | --------- | ------------------- | | `tx` | `` `0x${string}` `` | ###### Returns `Promise`\<[`StarknetReceipt`](#starknetreceipt) | `null`> ##### trace() > **trace**(`tx`): `Promise`\<[`StarknetInvocation`](#starknetinvocation) | `null`> `starknet_traceTransaction`'s `execute_invocation`; null: none. ###### Parameters | Parameter | Type | | --------- | ------------------- | | `tx` | `` `0x${string}` `` | ###### Returns `Promise`\<[`StarknetInvocation`](#starknetinvocation) | `null`> *** ### StarknetReceipt #### Properties | Property | Type | | -------------- | ------------------------------------------------------------- | | `blockNumber` | `bigint` \| `null` | | `execution` | `"SUCCEEDED"` \| `"REVERTED"` | | `finality` | `"PRE_CONFIRMED"` \| `"ACCEPTED_ON_L2"` \| `"ACCEPTED_ON_L1"` | *** ### StarknetRef The read keys recorded at claim; `transaction` is added when the facilitator names it. #### Properties | Property | Type | Description | | --------------- | ------------------------------------- | --------------------------------------------------------------------------- | | `asset` | `` `0x${string}` `` | - | | `from` | `` `0x${string}` `` | The payer's account: the contract whose outside-execution nonce is `nonce`. | | `idDigest` | `` `0x${string}` `` | - | | `network` | [`StarknetNetwork`](#starknetnetwork) | - | | `nonce` | `` `0x${string}` `` | - | | `settleBy` | `number` | - | | `transaction?` | `` `0x${string}` `` | - | *** ### StarknetUnsigned #### Properties | Property | Type | Description | | ------------------- | --------------------------------------------------------- | ---------------------------------------------------------------------- | | `request` | `object` | The typed data the account's key signs; SNIP-12 hashes the account in. | | `request.account` | `` `0x${string}` `` | - | | `request.kind` | `"starknet-snip12"` | - | | `request.typedData` | [`OutsideExecutionTypedData`](#outsideexecutiontypeddata) | - | #### Methods ##### complete() > **complete**(`signature`): [`Refusal`](https://lcp.integraledger.com/reference/api#refusal) | [`StarknetPayment`](#starknetpayment) Takes the signature as 1 to 32 felts. ###### Parameters | Parameter | Type | | ----------- | ------------------------------- | | `signature` | readonly `` `0x${string}` ``\[] | ###### Returns [`Refusal`](https://lcp.integraledger.com/reference/api#refusal) | [`StarknetPayment`](#starknetpayment) ## Type Aliases ### Felt > **Felt** = `` `0x${string}` `` Lowercase `0x` hex with no leading zero digit, below FELT\_P. *** ### StarknetNetwork > **StarknetNetwork** = `"starknet:SN_MAIN"` | `"starknet:SN_SEPOLIA"` *** ### StarknetPayment > **StarknetPayment** = [`X402Payment`](https://lcp.integraledger.com/reference/api/x402#x402payment)\<\{ `from`: [`Felt`](#felt); `outsideExecution`: \{ `signature`: readonly [`Felt`](#felt)\[]; `typedData`: [`OutsideExecutionTypedData`](#outsideexecutiontypeddata); }; }> *** ### StarknetStatus > **StarknetStatus** = \{ `blockNumber`: `bigint`; `finality`: `"ACCEPTED_ON_L2"` | `"ACCEPTED_ON_L1"`; `state`: `"settled"`; } | \{ `state`: `"pending"`; `why`: `"not-found"` | `"pre-confirmed"` | `"unreadable"`; } | \{ `state`: `"failed"`; `why`: `"reverted"` | `"not-this-instrument"`; } ## Variables ### ANY\_CALLER > `const` **ANY\_CALLER**: `"0x414e595f43414c4c4552"` = `"0x414e595f43414c4c4552"` The SNIP-9 any-caller sentinel, the short string `ANY_CALLER`. *** ### exactStarknet > `const` **exactStarknet**: `Readonly`\<\{ `advertise`: (`doc`, `h`, `link`, `offer`, `agreementUrl?`) => [`Refusal`](https://lcp.integraledger.com/reference/api#refusal) | [`PaymentRequired`](https://lcp.integraledger.com/reference/api/x402#paymentrequired); `bound`: (`presented`) => `Promise`\<`` `0x${string}` `` | [`Refusal`](https://lcp.integraledger.com/reference/api#refusal)>; `build`: (`c`, `h`) => `Promise`\<[`Refusal`](https://lcp.integraledger.com/reference/api#refusal) | [`StarknetUnsigned`](#starknetunsigned)>; `claims`: `boolean`; `id`: `"x402/exact/starknet"`; `pattern`: [`LcpPattern`](https://lcp.integraledger.com/reference/api/x402#lcppattern); `read`: (`doc`) => [`Refusal`](https://lcp.integraledger.com/reference/api#refusal) | [`X402Read`](https://lcp.integraledger.com/reference/api/x402#x402read); `reference`: (`presented`) => `Promise`\<[`Refusal`](https://lcp.integraledger.com/reference/api#refusal) | [`StarknetRef`](#starknetref)>; `status`: (`ref`, `reader`) => `Promise`\<[`StarknetStatus`](#starknetstatus)>; `tie`: (`accepts`, `request`) => \[`"x402"`, \{ `accepts`: readonly [`PaymentRequirements`](https://lcp.integraledger.com/reference/api/x402#paymentrequirements)\[]; `request`: [`RequestCommitment`](https://lcp.integraledger.com/reference/api/x402#requestcommitment); }]; `unplaced`: (`option`) => [`PaymentRequirements`](https://lcp.integraledger.com/reference/api/x402#paymentrequirements); }> *** ### FELT\_P > `const` **FELT\_P**: `bigint` *** ### MASK\_250 > `const` **MASK\_250**: `bigint` *** ### SELECTOR\_EXECUTE\_FROM\_OUTSIDE\_V2 > `const` **SELECTOR\_EXECUTE\_FROM\_OUTSIDE\_V2**: `"0x34cc13b274446654ca3233ed2c1620d4c5d1d32fd20b47146a3371064bdc57d"` = `"0x34cc13b274446654ca3233ed2c1620d4c5d1d32fd20b47146a3371064bdc57d"` sn\_keccak("execute\_from\_outside\_v2") *** ### SELECTOR\_TRANSFER > `const` **SELECTOR\_TRANSFER**: `"0x83afd3f4caedc6eebf44246fe54e38c95e3179a5ec9ea81740eca5b482d12e"` = `"0x83afd3f4caedc6eebf44246fe54e38c95e3179a5ec9ea81740eca5b482d12e"` sn\_keccak("transfer") ## Functions ### chainIdFelt() > **chainIdFelt**(`n`): `` `0x${string}` `` The network's reference as a short-string felt. #### Parameters | Parameter | Type | | --------- | ------------------------------------- | | `n` | [`StarknetNetwork`](#starknetnetwork) | #### Returns `` `0x${string}` `` *** ### outsideExecution() > **outsideExecution**(`a`): [`Refusal`](https://lcp.integraledger.com/reference/api#refusal) | [`OutsideExecutionTypedData`](#outsideexecutiontypeddata) x402's `OutsideExecution` for one `transfer(payTo, amount)` on `asset`, with the fee payer as `Caller`. #### Parameters | Parameter | Type | | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `a` | \{ `amount`: `bigint`; `asset`: `` `0x${string}` ``; `executeBefore`: `number`; `feePayer`: `` `0x${string}` ``; `network`: [`StarknetNetwork`](#starknetnetwork); `nonce`: `` `0x${string}` ``; `payTo`: `` `0x${string}` ``; } | | `a.amount` | `bigint` | | `a.asset` | `` `0x${string}` `` | | `a.executeBefore` | `number` | | `a.feePayer` | `` `0x${string}` `` | | `a.network` | [`StarknetNetwork`](#starknetnetwork) | | `a.nonce` | `` `0x${string}` `` | | `a.payTo` | `` `0x${string}` `` | #### Returns [`Refusal`](https://lcp.integraledger.com/reference/api#refusal) | [`OutsideExecutionTypedData`](#outsideexecutiontypeddata) *** ### pairingOf() > **pairingOf**(`option`): `"x402/exact/starknet"` | `undefined` This pairing's id for an option it can pay, or undefined. #### Parameters | Parameter | Type | | --------- | ---------------------------------------------------------------- | | `option` | [`PaymentRequirements`](https://lcp.integraledger.com/reference/api/x402#paymentrequirements) | #### Returns `"x402/exact/starknet"` | `undefined` *** ### snNonce() > **snNonce**(`h`): `` `0x${string}` `` | [`Refusal`](https://lcp.integraledger.com/reference/api#refusal) The hash's low 250 bits as a felt: the way Starknet fits a 256-bit hash into a felt. A value that is not a 32-byte hash is `x402/payload-malformed`. #### Parameters | Parameter | Type | | --------- | ------------------- | | `h` | `` `0x${string}` `` | #### Returns `` `0x${string}` `` | [`Refusal`](https://lcp.integraledger.com/reference/api#refusal) *** ### starknetIdDigest() > **starknetIdDigest**(`from`, `to`, `amount`): `Promise`\<`` `0x${string}` `` | [`Refusal`](https://lcp.integraledger.com/reference/api#refusal)> the core's `hash` over `from`, `to` and `amount` as three 32-byte big-endian words: the identity of one transfer. #### Parameters | Parameter | Type | | --------- | ------------------- | | `from` | `` `0x${string}` `` | | `to` | `` `0x${string}` `` | | `amount` | `bigint` | #### Returns `Promise`\<`` `0x${string}` `` | [`Refusal`](https://lcp.integraledger.com/reference/api#refusal)> *** ### starknetLandedNonce() > **starknetLandedNonce**(`ref`, `reader`): `Promise`\<`` `0x${string}` `` | [`Refusal`](https://lcp.integraledger.com/reference/api#refusal)> The nonce that landed in the named transaction for this transfer, for a party holding the ATR to compare with the hash's low 250 bits. It is found by the transfer's identity on `ref.asset`, not by the recorded nonce. #### Parameters | Parameter | Type | | --------- | ---------------------------------------- | | `ref` | [`StarknetRef`](#starknetref) & `object` | | `reader` | [`StarknetReader`](#starknetreader) | #### Returns `Promise`\<`` `0x${string}` `` | [`Refusal`](https://lcp.integraledger.com/reference/api#refusal)> *** ### starknetStatus() > **starknetStatus**(`ref`, `reader`): `Promise`\<[`StarknetStatus`](#starknetstatus)> Reads the named transaction's receipt, then walks its trace for exactly one non-reverted `execute_from_outside_v2` whose calldata carries this nonce and whose direct, non-reverted call is `transfer` on `ref.asset` with this transfer's identity. A failed read, or a reader for another network, is pending. Two calls. #### Parameters | Parameter | Type | | --------- | ---------------------------------------- | | `ref` | [`StarknetRef`](#starknetref) & `object` | | `reader` | [`StarknetReader`](#starknetreader) | #### Returns `Promise`\<[`StarknetStatus`](#starknetstatus)>