Releases: coinbase/onchainkit
v0.5.2
Patch Changes
- fix:
<FrameMetadata>
component when used with Helmet. To ensure smooth functionality when used with Helmet as a wrapper component, it is crucial to flatten the Buttons loop. By @Zizzamia #99 cefcfa8 - feat: added
Avatar
component, to our Identity Kit. TheAvatar
component primarily focuses on showcasing ENS avatar for given Ethereum addresses, and defaults to a default SVG avatar when an ENS avatar isn't available. By @alvaroraminelli #69
v0.5.1
Patch Changes
- feat: added option for mint action on a Frame. By @Zizzamia #93
- feat: added option for simple static links when creating a Frame. By @Zizzamia #93
- feat: added
wrapper
prop to<FrameMetadata />
component, that defaults toReact.Fragment
when not passed (original behavior). By @syntag #90 #91 - feat: exported
FrameMetadataResponse
type which can be useful when usinggetFrameMetadata
in a TS project. By @syntag #90
v0.5.0
Minor Changes
-
fix: ensured that the
<FrameMetadata>
component uses thename
property instead of theproperty
property to set the type of metadata. Both options are technically correct, but historically, usingname
is more accurate. By @Zizzamia dc6f33d -
feat: renamed the component from
OnchainName
toName
in our Identity Kit. This is a breaking changes. The purpose of the rename is to simplify and enhance clarity. By @alvaroraminelli #86BREAKING CHANGES
To enhance usability and intuitiveness, the component name has been simplified.
OnchainName
is now renamed toName
.Before
import { OnchainName } from '@coinbase/onchainkit'; ... <OnchainName address="0x1234">
After
import { Name } from '@coinbase/onchainkit'; ... <Name address="0x1234">
v0.4.5
v0.4.4
v0.4.3
v0.4.2
Patch Changes
- feat: Added support for Text Input metadata for Farcaster Frames. By @taycaldwell #67 89e5210
- feat: Added
FrameMetadata
component, to help support metadata elements with classic React apps. By @Zizzamia #71 - feat: Added
OnchainName
component, to our Identity Kit. TheOnchainName
component primarily focuses on showcasing ENS names for given Ethereum addresses, and defaults to displaying a sliced version of the address when an ENS name isn't available. By @alvaroraminelli #49
v0.4.1
Minor Changes
- feat: the
getFrameAccountAddress
function has been deprecated. Now, thegetFrameMessage
function also returns the Account Address. #60 0355c73 - feat: integrated with Neynars API to obtain validated messages and additional context, such as recast, follow-up, etc. By @robpolak #59
- fix: removed the Farcaster references due to build errors and compatibility issues. By @robpolak #59
BREAKING CHANGES
We received feedback regarding our initial approach with OnchainKit, which had excessive dependencies on Node.js-only libraries. This caused issues when integrating the library with React Native and the latest version of Node (e.g., v21).
In response to this feedback, we decided to utilize Neynar to simplify our approach and implementation of the getFrameMessage
method. By incorporating Neynar, you now have no dependencies for that particular method and will also receive additional data to enhance your Frame.
Therefore, as getFrameMessage
relies on Neynar, it is necessary to provide a Neynar API KEY when using the method in order to avoid rate limiting.
Before
import { getFrameMessage } from '@coinbase/onchainkit';
...
const { isValid, message} = await getFrameMessage(body);
After
import { getFrameMessage } from '@coinbase/onchainkit';
...
const { isValid, message } = await getFrameMessage(body , {
neynarApiKey: 'NEYNAR_ONCHAIN_KIT'
});
Additionally, the getFrameMessage
function now returns the Account Address. As a result, we no longer require the use of getFrameAccountAddress
.
This enhancement allows us to accomplish more with less code!
v0.4.0
Minor Changes
- feat: deprecated
getFrameAccountAddress
as nowgetFrameMessage
returns also the Account Address. #60 0355c73 - feat: integrated with Neynars api to get validated messages + additional context like recast/follow/etc. By @robpolak #59
- fix: removed farcaster references as they were generating build errors and compatibility issues. By @robpolak #59
BREAKING CHANGES
I will write the breaking changes in the next PR
v0.3.1
Patch Changes
- feat: introducing
getFrameHtmlResponse
server-side helper method: generates HTML response with valid Frame, usesFrameMetadata
types for page metadata, eliminates manual creation of server-side HTML strings. 5d80499 - feat: the
FrameMetadata
type have been updated. Now,buttons
andpost_url
are considered optional, aligning with the Farcaster Frames API. - feat: going forward, we will utilize
NEYNAR_ONCHAIN_KIT
as the default free API key for Neynar.